|
| 1 | +# Releases |
| 2 | + |
| 3 | +The repository uses the shared Hoverkraft release actions to calculate versions, |
| 4 | +publish GitHub releases, and generate release summaries. |
| 5 | + |
| 6 | +## Release preparation |
| 7 | + |
| 8 | +[Prepare release](../../.github/workflows/__prepare-release.yml) runs on pushes to |
| 9 | +`main` and when pull requests targeting `main` are opened, reopened, updated, or |
| 10 | +edited. It applies the shared Conventional Commit labels to pull requests. |
| 11 | + |
| 12 | +The shared release configuration increments the major version for breaking |
| 13 | +changes, the minor version for features, and the patch version for other changes. |
| 14 | +Tags use the existing `MAJOR.MINOR.PATCH` format. No repository override is needed |
| 15 | +for these defaults. |
| 16 | + |
| 17 | +## Publishing |
| 18 | + |
| 19 | +[Release](../../.github/workflows/__release.yml) runs every Monday at 08:25 UTC and |
| 20 | +supports manual dispatch. It runs only on the default branch and: |
| 21 | + |
| 22 | +1. Runs the shared CI workflow. |
| 23 | +2. Plans a release for the exact commit validated by CI. |
| 24 | +3. Creates and publishes the release when relevant changes exist and a tag was |
| 25 | + planned. Release notes include a generated summary. |
| 26 | + |
| 27 | +Failed or skipped CI prevents publication. Concurrent release runs are serialized. |
| 28 | +The GitHub App token lets the new tag trigger |
| 29 | +[main CI](../../.github/workflows/__main-ci.yml), which regenerates action and |
| 30 | +workflow documentation and sends its artifact to the public documentation site. |
| 31 | + |
| 32 | +To release manually, open **Actions → Internal - Release → Run workflow** and |
| 33 | +select `main`. Leave `force` disabled for normal releases. Enable it only to bypass |
| 34 | +the no-changes check; the default-branch restriction, CI checks, and planned-tag |
| 35 | +requirement still apply. |
| 36 | + |
| 37 | +## Credentials |
| 38 | + |
| 39 | +The workflow uses repository or inherited organization settings: |
| 40 | + |
| 41 | +| Setting | Kind | Purpose | |
| 42 | +| ------------------------ | -------- | ------------------------------------------------------------------------------- | |
| 43 | +| `CI_BOT_APP_CLIENT_ID` | Variable | Identify the installed CI bot GitHub App. | |
| 44 | +| `CI_BOT_APP_PRIVATE_KEY` | Secret | Create an installation token with Contents write and Pull requests read access. | |
| 45 | +| `OPENAI_API_KEY` | Secret | Generate the release summary. | |
| 46 | + |
| 47 | +The GitHub App must be installed on this repository and allowed to create release |
| 48 | +tags. Keep these settings available to the repository before enabling scheduled |
| 49 | +releases. |
0 commit comments