stevepinero / go

The Microsoft build of the Go toolset

The Go Programming Language

Go is an open source programming language that makes it easy to build simple, reliable, and efficient software.

This repository, microsoft/go, contains the infrastructure Microsoft uses to build Go. The submodule named go contains the Go source code. By default, the submodule's remote URL is the official GitHub mirror of Go, golang/go. The canonical Git repository for Go source code is located at https://go.googlesource.com/go.

This project is not involved in producing the official binary distributions of Go.

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.

If you are using this fork and have a Microsoft corporate account, consider clicking here to instantly join the Microsoft Go Toolset Announcements email distribution list 📧 and receive notifications about Microsoft releases of Go and breaking changes. We also maintain an internal doc page.

Why does this fork exist?

This repository produces a modified version of Go that can be used to build FIPS 140-2 compliant applications. Our goal is to share this implementation with others in the Go community who have the same requirement, and to merge this capability into upstream Go as soon as possible. See eng/doc/fips for more information about this feature and the history of FIPS 140-2 compliance in Go.

The binaries produced by this repository are also intended for general use within Microsoft instead of the official binary distribution of Go.

We call this repository a fork even though it isn't a traditional Git fork. Its branches do not share Git ancestry with the Go repository. However, the repository serves the same purpose as a Git fork: maintaining a modified version of the Go source code over time.

Support

This project follows the upstream Go Release Policy. This means we support each major release (1.X) until there are two newer major releases. A new Go major version is released every six months, so each Go major version is supported for about one year.

When upstream Go releases a new minor version (1.X.Y), we release a corresponding microsoft/go version that may also include fork-specific changes. This normally happens once a month. At any time, we may release a new revision (1.X.Y-Z) to fix an issue without waiting for the next upstream minor release. Revision releases are uncommon.

Each microsoft/go release is announced in the internal Microsoft Go Toolset Announcements email distribution list 📧.

Download and install

This repository's infrastructure currently supports these OS/Arch combinations:

• linux_amd64
• linux_armv6l
• linux_arm64
• windows_amd64

See eng/README.md for more details about the infrastructure.

Binary distribution

• microsoft/go-images distributes the binaries of this Go fork by producing Docker images that are published to the Microsoft Container Registry. This is the recommended way to use the Microsoft build of Go.

• Binary archives: visit the microsoft/main branch eng/doc/Downloads.md file to download binaries and source tarballs built by supported release branches.

• GitHub Releases: the microsoft/go GitHub releases have source code archive attachments and an assets.json file that can be used to locate the binaries for that release.

Don't see an option that works for you? Let us know! File a GitHub issue, or comment on an existing issue in this tag:

Build from source

Prerequisites:

• PowerShell 6+
• Go install from source prerequisites
  • Exception: this repository's build script automatically downloads a bootstrap version of Go.

After cloning the repository, use the following build command. You can pass the -help flag to show more options:

pwsh eng/run.ps1 build -refresh

The resulting Go binary can then be found at go/bin/go.

If you download a source archive from a GitHub release, use the official Go install from source instructions. These source archives only include the go directory, not the microsoft/go build infrastructure.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.