3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-04-28 09:56:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

deployment: update RELEASING.md (#3503)

Browse source 
update RELEASING.md

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
This commit is contained in:
bobby 2022-08-16 10:40:03 -07:00 • committed by GitHub
parent 0e73bd31f7
commit c9421ec146
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
RELEASING.md
View file

@ -1,40 +1,37 @@
# Overall process
1. Add new branch to netlify build settings (new release branch only)
2. Request new subdomain for netlify TLS certificate (new release branch only)
3. Generate changelog
4. Update docs/upgrading.md for major/minor releases
5. Update vuepress branch config in `config.js`
1. Set new default text nav
2. Add new branch to item list
6. Create a new release branch for major/minor releases, eg `0-15-0`, off main. Patch releases use existing release branches.
7. Create Github release with name and tag matching `v[version]` on the appropriate release branch.
8. Copy/paste changelog from generated output into Github release notes
9. GH automation should take it from there and build/upload artifacts
10. Update default branch on netlify to new release branch (new release branch only)
## Core
# Changelog generation
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.out
The changelog will be written to changelog.md
## Major/minor release example
#### Major/minor release example
```bash
GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.0 v0.15.0 main changelog.out
GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.0 v0.15.0 main changelog.md
```
## Patch release example
### Patch release example
```bash
GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.6 v0.14.7 main changelog.out
GITHUB_TOKEN=XXXXXX ./changelog.sh v0.14.6 v0.14.7 main changelog.md
```
# Release branches
### 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.
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.