1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
# Prereqs
* You must have the [GitHub CLI tool (gh)](https://cli.github.com/)
installed, in your path, and logged into an account that can
make GitHub releases on the repo.
* Your environment also must have `bash`, `git` and `sed` available.
# Releasing
* Review open issues and PRs to see if anything needs to be addressed
before release.
* Create a branch e.g. `horgh/release` and switch to it.
* `main` is protected.
* Set the release version and release date in `CHANGELOG.md`. Be sure
the version follows [Semantic Versionsing](https://semver.org/).
* Mention recent changes if needed.
* Commit these changes.
* Run `dev-bin/release.sh`.
* You might need to initialize/update submodules to successfully run tests,
eg. `git submodule update --init --recursive`.
* Verify the release on the GitHub Releases page.
* If everything goes well, the authorized releasers will receive an email
to review the pending deployment. If you are an authorized releaser,
you will need to approve the release deployment run. If you are not,
you will have to wait for an authorized releaser to do so.
* Make a PR and get it merged.
|
