Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RELEASING.md #178

Closed
wants to merge 1 commit into from
Closed

Update RELEASING.md #178

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 7 additions & 16 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
## How to Release the SDK

1. Make sure that all changes for the release are merged with the `main` branch.
2. From the root directory of the project in the `main` branch, run the following commands.
1. `go install ./...`
2. `go test ./...`
3. `go vet ./...`
3. Run `go mod tidy` to make sure it doesn't introduce new changes. If it brings new changes, check those in first before doing the release.
4. Click **Releases** in the about section to get the details on the version history.
5. Decide what the version of the next release will be. We follow [semantic versioning](https://semver.org/).
6. Execute `git tag -a -m 'v0.10.3' 'v0.10.3'` replacing v0.10.3 with the new version.
7. Push the tag up to Github `git push upstream v0.10.3`.
8. Log into Github, click on **Releases** in the about section on the right, and click on **Draft a new release.**
9. For **version**, choose the version you decided upon in step 5.
10. Provide a short but descriptive title for the release.
11. Fill in the details of the release. Please copy the markdown from the previous release and follow the same format.
12. Click "Publish release."
13. From your home directory run `./scripts/add-release-to-pkg-go-dev.sh` to notify pkg.go.dev of the new version.
1. Make sure that all changes for the release are merged with the `main` branch, and that all tests are passing
2. Click **Releases** in the about section to get the details on the version history.
3. Decide what the version of the next release will be. We follow [semantic versioning](https://semver.org/).
8. In Github, click on **Releases** in the about section on the right, and click on **Draft a new release.**
9. For **version**, choose the version you decided upon in step 3.
10. Fill in the details of the release. Please do your best to follow the format of recent releases. Use the Github-generated release notes as a strating point.
11. Click "Publish release."