1# Releasing Packages
2
3After going through a minimal architects board review and preparing your package for release, verify you are ready for release by following the "Release Checklist", and finally release your package by following the "Release Process"
4
5## Release Checklist
6
7- [] Verify there are no replace directives in the go.mod file
8- [] Verify the package has a LICENSE file
9- [] Verify documentation is present and accurate for all public methods and types. Reference the [content guidelines](https://review.docs.microsoft.com/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#api-reference) for best practices. You can start the `godoc` server by running `godoc -http=:6060` from the module home and navigating to `localhost:6060` in the browser.
10- [] Verify there are no broken links
11- [] Verify all links are non-localized (no "en-us" in links)
12- [] Check the package manager link goes to the correct package
13- [] Verify Samples
14- [] Verify samples are visible in the [sample browser](https://docs.microsoft.com/samples/browse/)
15- [] Verify release notes follow [general guidelines](https://azure.github.io/azure-sdk/policies_releasenotes.html)
16- [] Verify troubleshooting section of README contains information about how to enable logging
17- [] Verify CHANGELOG follows [current guidance](https://azure.github.io/azure-sdk/policies_releases.html#changelog-guidance)
18- [] Verify all champion scenarios have a getting started scenario
19
20## Release Process
21
221. Complete all steps of the Release Checklist shown above
232. Mark the package as 'in-release' by running the `./eng/common/scripts/Prepare-Release.ps1` script and following the prompts. The script may update the version and/or `CHANGELOG.md` of the package. If changes are made, these changes need to be committed and merged before continuing with the release process.
243. Run the pipeline from the `internal` Azure Devops. This will require you to approve the release after both the live and recorded test pipelines pass.
254. Validate the package was released properly by running `go get <your-package>@<your-version>` (ie. `go get github.com/Azure/azure-sdk-for-go/sdk/azcore@v0.20.0`) and validating that pkg.go.dev has updated with the latest version.View as plain text