-
Notifications
You must be signed in to change notification settings - Fork 9
Release Process
E. Lynette Rayle edited this page Nov 30, 2022
·
6 revisions
go mod tidy
May have to install godoc first:
go get golang.org/x/tools/cmd/godoc
Generate documentation:
godoc -http=:6060 &
View generated documentation at: http://localhost:6060/pkg/github.com/github/spdx-expression/spdxexp
1. Choose a tag -> type new tag number starting with a `v` and following [Semantic Versioning](https://semver.org/) principles (e.g. v0.2.0)
2. Set title (e.g. Release v0.2.0)
3. Write release notes including sections: ([example](https://github.com/github/spdx-expression/releases/tag/v0.2.0))
1. Overview - brief description of the primary change(s)
2. Require Action for Upgrading - list any steps that are required to update to this version
3. Details - include a subsection with a description, examples, and other details for each change that impacts usage or functioning
4. What's Changed - simple list of major changes and link to diff from previous release to this release