docs(development): correct the release pipeline gates
Assisted-by: GLM 5.3 Flash
This commit is contained in:
+6
-4
@@ -53,9 +53,11 @@ just test
|
|||||||
7. Open a pull request against `development`.
|
7. Open a pull request against `development`.
|
||||||
|
|
||||||
Releases are cut by merging `development` into `main` and tagging `vX.Y.Z`. The
|
Releases are cut by merging `development` into `main` and tagging `vX.Y.Z`. The
|
||||||
release workflow runs the full gate set including the race detector and
|
release workflow validates the tag, runs the static gates and the test suite
|
||||||
publishes the Gitea release with the matching `CHANGELOG.md` section as its
|
with the coverage floor, and publishes the Gitea release with the matching
|
||||||
notes.
|
`CHANGELOG.md` section as its notes. The race detector is not in that set: race
|
||||||
|
never runs on a push path, and the local `just gates` raced the tree before the
|
||||||
|
tag was cut.
|
||||||
|
|
||||||
## Code style
|
## Code style
|
||||||
|
|
||||||
@@ -114,7 +116,7 @@ Workflows live in `.gitea/workflows/` and run on the project's own runners:
|
|||||||
|---|---|---|
|
|---|---|---|
|
||||||
| Test | push or pull request to `development` | format check, vet, modernisation, build, the test suite with the coverage floor, the toml-test compliance suite |
|
| Test | push or pull request to `development` | format check, vet, modernisation, build, the test suite with the coverage floor, the toml-test compliance suite |
|
||||||
| Race | `workflow_dispatch`, by hand | the suite under the race detector, the same race gate the local `just gates` runs |
|
| Race | `workflow_dispatch`, by hand | the suite under the race detector, the same race gate the local `just gates` runs |
|
||||||
| Release | a `v*` tag | the same gates plus the race detector, then the Gitea release created from the `CHANGELOG.md` section |
|
| Release | a `v*` tag | tag validation, format, vet, modernisation, build and the test suite with the coverage floor, then the Gitea release created from the `CHANGELOG.md` section; no race detector |
|
||||||
|
|
||||||
The local equivalent is `just gates`, which is the same set plus the race
|
The local equivalent is `just gates`, which is the same set plus the race
|
||||||
detector.
|
detector.
|
||||||
|
|||||||
+6
-5
@@ -97,12 +97,13 @@ pipeline.
|
|||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `test.yml` | push or pull request to `development` | format check, vet, modernisation, build, the test suite with the 80 percent coverage floor, then the toml-test compliance suite |
|
| `test.yml` | push or pull request to `development` | format check, vet, modernisation, build, the test suite with the 80 percent coverage floor, then the toml-test compliance suite |
|
||||||
| `race.yml` | `workflow_dispatch`, by hand | the suite under the race detector; the same race gate `just gates` runs locally |
|
| `race.yml` | `workflow_dispatch`, by hand | the suite under the race detector; the same race gate `just gates` runs locally |
|
||||||
| `release.yml` | a `v*` tag | the same gates plus the race detector, then the Gitea release from the CHANGELOG section |
|
| `release.yml` | a `v*` tag | tag validation, then format, vet, modernisation, build and the test suite with the coverage floor, then the Gitea release from the CHANGELOG section. No race detector: race never runs on a push path, and the local `just gates` raced the tree before the tag was cut |
|
||||||
|
|
||||||
## Releases
|
## Releases
|
||||||
|
|
||||||
Releases are cut by merging `development` into `main` and tagging `vX.Y.Z`. The
|
Releases are cut by merging `development` into `main` and tagging `vX.Y.Z`. The
|
||||||
tag drives the release workflow: it validates the tag, runs the full gate set
|
tag drives the release workflow: it validates the tag, runs the static gates
|
||||||
including the race detector, extracts the matching `## [X.Y.Z]` section from
|
and the test suite with the coverage floor, extracts the matching `## [X.Y.Z]`
|
||||||
`CHANGELOG.md`, and publishes the release with that section as its body. A
|
section from `CHANGELOG.md`, and publishes the release with that section as its
|
||||||
library ships no binaries, so the release carries the notes and nothing else.
|
body. A library ships no binaries, so the release carries the notes and nothing
|
||||||
|
else.
|
||||||
|
|||||||
Reference in New Issue
Block a user