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

Jump to bottom

Add release notes to README file. #103

Merged
merged 3 commits into from
Sep 6, 2022
Merged

Add release notes to README file. #103

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1540bf9
Add release notes to README file.
keep94 Sep 1, 2022
bb1e929
Changes from oppegard and shavidissa.
keep94 Sep 2, 2022
6e57596
Renumber release steps after deleting one about open ports.
keep94 Sep 6, 2022
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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
* [Close the Sender](#close-the-sender)
* [License](#License)
* [How to Get Support and Contribute](#how-to-get-support-and-contribute)
* [How to Release the SDK](#how-to-release-the-sdk)

# Welcome to the Wavefront Go SDK

Expand Down Expand Up @@ -306,3 +307,27 @@ sender.Close()

* Reach out to us on our public [Slack channel](https://www.wavefront.com/join-public-slack).
* If you run into any issues, let us know by creating a GitHub issue.

## How to Release the SDK

1. Make sure that all changes for the release are merged with the master branch.
2. From the root directory of the project in the master branch, check that the following command run cleanly.
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 on "Publish release."
13. From your home directory run `mkdir -p go/src/cmd/scratch`.
14. Run `cd go/src/cmd/scratch`.
15. Run `go mod init`.
16. Run `go get github.com/wavefronthq/[email protected]` replacing v0.10.3 with the version you just published.
17. Step 16 lets `pkg.go.dev` know that there is a new version of the SDK to cache.
18. After 15 minutes, go to [pkg.go.dev](https://pkg.go.dev/github.com/wavefronthq/wavefront-sdk-go) and see if the version upgraded. Once the version upgrades on `pkg.go.dev`, all the go users get the new version you just published.