Skip to content

Release Process

E. Lynette Rayle edited this page Nov 30, 2022 · 6 revisions

1. Clean up dependencies (Removes any packages no longer in use.)

go mod tidy

View generated documentation at: http://localhost:6060/pkg/github.com/github/spdx-expression/spdxexp

2. Generate documentation to be sure it is correct

godoc -http=:6060 &
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)
1. Set title (e.g. Release v0.2.0)
1. 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)
    1. Require Action for Upgrading - list any steps that are required to update to this version
    1. Details - include a subsection with a description, examples, and other details for each change that impacts usage or functioning
    1. What's Changed - simple list of major changes and link to diff from previous release to this release

4. Release to go packages

Clone this wiki locally