Skip to content

Commit dce2514

Browse files
committed
docs: add release process/drafter sections
1 parent edf21f4 commit dce2514

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/Releases.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,19 @@ Release notes use PR titles directly. They should be written as user-facing chan
4747
**Not good: ** fix: bug from last community call
4848

4949
Keep in mind that maintainers may adjust the labels manually if appropriate.
50+
51+
## Release Process
52+
53+
The actual release process is largely automated via two GitHub Actions workflows: [`release-drafter.yml`](https://github.com/finos/git-proxy/blob/main/.github/release-drafter.yml) and [`npm.yml`](https://github.com/finos/git-proxy/blob/main/.github/workflows/npm.yml).
54+
55+
### Release Drafter
56+
57+
This workflow runs against each `release/*` branch and generates a draft GitHub Release, which is kept up-to-date with a categorised changelog and the right version number. A preview draft is also maintained against `main` so contributors can see what's coming up in the next minor - a roadmap of work in flight.
58+
59+
When a release is ready to ship, a maintainer:
60+
61+
1. Reviews the draft for the relevant `release/*` branch
62+
2. Edits the release notes if necessary (for instance, adding a migration guide for breaking changes)
63+
3. Clicks Publish.
64+
65+
Publishing creates a git tag, and triggers the `npm.yml` workflow described below.

0 commit comments

Comments
 (0)