Skip to content

Commit f7383fd

Browse files
committed
chore: instructions about version number and stable branches
Signed-off-by: Vitor Mattos <[email protected]>
1 parent 565ff4d commit f7383fd

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

developer_manual/release-process.rst

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,55 @@
11
Release process
22
===============
33

4-
The release process will start creating an issue using one of the following name suggestions:
4+
Version numbers
5+
---------------
6+
7+
- The version number follows **MAJOR.MINOR.PATCH**.
8+
- ``MAJOR`` aligns with the supported Nextcloud Server version (see :ref:`supported-nextcloud-versions`).
9+
- ``MINOR`` is used for LibreSign feature releases.
10+
- ``PATCH`` is used for bug fixes or small improvements.
11+
12+
Stable branches
13+
---------------
14+
15+
Each **stable branch** in LibreSign corresponds to a specific Nextcloud **MAJOR** version.
16+
For example: ``stable21`` is compatible with Nextcloud 21.
17+
18+
Release checklist
19+
-----------------
20+
21+
A new release starts by creating a GitHub issue with one of the following titles:
522

623
.. code-block:: plain
724
8-
Release process for v20.1.9
9-
Release process for v20.1.9 and v20.1.8
25+
🚀 Release todo v20.1.9
26+
🚀 Release todo v20.1.9 and v20.1.8
1027
11-
To the body, add the following template. Read all and replace the placeholders with the correct values.
28+
In the body, paste and adapt the following template. Replace placeholders
29+
with the correct values as you progress through the steps.
1230

1331
.. code-block:: markdown
1432
15-
<!-- CASE SENSITIVE replace the following strings in the template -->
1633
<!-- 1. Replace "20.1.9" with the version number e.g. "12.2.4" -->
1734
<!-- Replace "20.1.8" with the previous version number e.g. "12.2.3" -->
1835
<!-- 2. Replace "stable30" with the LibreSign minor branch name e.g. "stable22" -->
19-
<!-- 3. Replace "20" with the LibreSign version e.g. "12" for "stable22" -->
20-
<!-- 4. Replace CASE SENSITIVE "XX" with the Nextcloud stable branch number e.g. "22" for "stable22" -->
2136
## 💺 Preparation
2237
- [ ] Check there are no pending backports:
23-
- [ ] https://github.com/LibreSign/libresign/labels/backport-request
38+
- [ ] https://github.com/LibreSign/libresign/labels/backport-request
2439
- [ ] Check all milestones don't have priority issues still open
2540
<!-- Add above the link of stables that will be involved in this release process -->
2641
<!-- Get branches/versions to release from https://github.com/LibreSign/libresign/milestones -->
27-
- [ ] https://github.com/LibreSign/libresign/milestone/318
28-
- [ ] https://github.com/LibreSign/libresign/milestone/319
42+
- [ ] https://github.com/LibreSign/libresign/milestone/<!-- put here the milestone ID e.g. 318 -->
43+
- [ ] https://github.com/LibreSign/libresign/milestone/<!-- put here the milestone ID e.g. 319 -->
2944
- [ ] Check there are no important PRs open against the branch
3045
<!-- Add above the link with correct base branch of stables that will be involved in this release process -->
3146
<!-- Get branches/versions to release from https://github.com/LibreSign/libresign/milestones -->
3247
- [ ] https://github.com/LibreSign/libresign/pulls?q=is%3Apr+is%3Aopen+base%3Astable30
3348
- [ ] https://github.com/LibreSign/libresign/pulls?q=is%3Apr+is%3Aopen+base%3Astable31
3449
- [ ] List all PRs that will be added to the changelog
35-
<!-- List the content to add at the pull request using the follow command and pay attention to replace the milestone name and the version number:
50+
<!-- List the content to add at the pull request using the follow command and pay attention to replace the XX by the Nextcloud version:
3651
37-
gh pr list --repo LibreSign/libresign --state merged -S "milestone:\"Next Patch (30)\" " -L 100
52+
gh pr list --repo LibreSign/libresign --state merged -S "milestone:\"Next Patch (XX)\" " -L 100
3853
-->
3954
- [ ] Create a PR against main branch at the `CHANGELOG.md` file with the changelog of all milestones that are subject to the release. Look the pattern used in the file and follow it.
4055
<!-- name suggestions to commit and pull request:
@@ -45,6 +60,10 @@ To the body, add the following template. Read all and replace the placeholders w
4560
- [ ] Merge the PR
4661
<!-- Duplicate the follow steps for each version that will be released, starting with the oldest version. -->
4762
<!-- Pay attention to start with the **oldest** version here, so the appstore and github releases show the newest version as "Last release" and them. -->
63+
<!-- Replace "XX" with the Nextcloud stable branch number e.g. "22" for "stable22" -->
64+
<!-- 1. Replace "20.1.9" with the version number e.g. "12.2.4" -->
65+
<!-- Replace "20.1.8" with the previous version number e.g. "12.2.3" -->
66+
<!-- 2. Replace "stable30" with the LibreSign minor branch name e.g. "stable22" -->
4867
## 🚀 v20.1.9
4968
- [ ] Backport the changelog from main to the stable branches
5069
- [ ] <!-- Add link to PR here -->
@@ -69,6 +88,8 @@ To the body, add the following template. Read all and replace the placeholders w
6988
- [ ] Move all open PRs and issues from milestone `v20.1.9` to `💚 Next Patch (XX)`: https://github.com/LibreSign/libresign/issues?q=is%3Aissue%20state%3Aopen%20milestone%3Av20.1.9
7089
- [ ] Move all open PRs and issues from milestone `v20.1.9` to `💚 Next Patch (XX)`: https://github.com/LibreSign/libresign/issues?q=is%3Apr%20state%3Aopen%20milestone%3Av20.1.9
7190
- [ ] Close the `v20.1.9` milestone
91+
- [ ] Archive all issues and PRs that were merged in this release
92+
- [ ] https://github.com/orgs/LibreSign/projects/2/views/4
7293
- [ ] Create a new release
7394
- [ ] Prepare a (pre-)release in https://github.com/LibreSign/libresign/releases/new?tag=v20.1.9&target=stable30
7495
- [ ] Make sure that chosen tag is v20.1.9, target is stable30, and previous tag is v20.1.8

0 commit comments

Comments
 (0)