Skip to content

Commit 7a4c01c

Browse files
authored
Merge pull request #113 from nextcloud-releases/docs/pre-release-requirements
docs: add pre-release requirements section
2 parents d7b6432 + 0181ab0 commit 7a4c01c

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,25 @@ beta of a major opens the *next* major milestone (`vN.0.0beta1` creates
5858
missing it fails; the one after is optional and set only when listed. Full
5959
details and examples are in [`tools/release/README.md`](tools/release/README.md).
6060

61+
## Pre-release requirements
62+
63+
These must hold before a release is triggered, otherwise the pipeline fails or
64+
produces a wrong result:
65+
66+
1. **The release schedule is up-to-date.** `release-schedule.json`
67+
must list a due date for the next patch milestone of the series being released
68+
(for example `Nextcloud 34.0.4`). A stable release whose next milestone has no
69+
due date fails in the milestones step. Add the missing entries ahead of time.
70+
2. **The major has a config JSON.** `stable<N>.json` for stable releases and RCs,
71+
or `master.json` for a new major alpha or beta. It must list every bundled app.
72+
3. **The version bump PR is merged on server.** `version.php` on the target branch
73+
must already state the version being released, so the tag and `version.php`
74+
match.
75+
76+
The release itself is triggered by the legacy release script, which dispatches
77+
`release.yml`. It is not started by hand. Re-running individual workflows for
78+
recovery is covered in [Running manually](#running-manually).
79+
6180
## Release configuration
6281

6382
One JSON file per major version lists all bundled apps:

0 commit comments

Comments
 (0)