doc: release process

[Michael McLoughlin]

Document release process.

[Michael McLoughlin]

Release Process

1. Version Bump

Use version bump script:

./script/bump <version>

Create a pull request with the changes:

hub pull-request --push

Example: #86. Merge the pull request when CI passes.

2. Tag

Run checks to confirm the release is ready to tag.

go run ./internal/tools/release check

Create the tag (with the v prefix):

git tag -a v<version> -m "release <version>"

When ready, push to remote:

git push origin v<version>

3. Github Release

Pushing the tag should trigger the release action.

For example: https://github.com/mmcloughlin/addchain/actions/runs/718582318.

This will create a draft release. Review manually and publish.

4. Zenodo Upload

Use the release tool to upload to Zenodo:

$ go run ./internal/tools/release upload
release: downloaded zip archive bytes 181749
release: loaded zenodo metadata from "/Users/mbm/Development/addchain/.zenodo.json"
release: updated zenodo metadata
release: cleared all files from zenodo deposit
release: uploaded file "addchain_0.2.0.zip"
release: publish skipped: review and publish at "https://zenodo.org/deposit/4662389"

Browse to the provided link to review and publish manaully.