mirror of
https://github.com/pomerium/pomerium.git
synced 2025-04-28 09:56:31 +02:00
c9421ec146
update RELEASING.md Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# Overall process
|
|
|
|
## Core
|
|
|
|
1. Generate changelog
|
|
2. Update docs/upgrading.md for major/minor releases
|
|
4. Create a new release branch for major/minor releases, eg `0-15-0`, off main. Patch releases use existing release branches.
|
|
5. Create Github release with name and tag matching `v[version]` on the appropriate release branch.
|
|
6. Copy/paste changelog from generated output into Github release notes
|
|
7. GH automation should take it from there and build/upload artifacts
|
|
8. Update default branch on netlify to new release branch (new release branch only)
|
|
|
|
### Changelog generation
|
|
|
|
`./scripts/changelog.sh [previous version] [next version] [branch]`
|
|
|
|
This script requires docker running and GITHUB_TOKEN set with a PAT.
|
|
|
|
The changelog will be written to changelog.md
|
|
|
|
#### Major/minor release example
|
|
|
|
```bash
|
|
GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.0 v0.15.0 main changelog.md
|
|
```
|
|
|
|
### Patch release example
|
|
|
|
```bash
|
|
GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.6 v0.14.7 main changelog.md
|
|
```
|
|
|
|
### Release branches
|
|
|
|
For each major or minor release, we create a release branch `[major]-[minor]-0`. This is to allow feature freeze ahead of actual release and provide a stable branch to apply patches onto for bug fixes.
|
|
|
|
These branches are to be protected and may receive updates via backport or direct PR.
|