Skip to content

Commit af9852a

Browse files
authored
[Doc] document the release process (#631)
1 parent 5f6d0a3 commit af9852a

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Release process
2+
3+
Shamrock is released on a 6 months basis. The release process goes as follows.
4+
5+
## Changing the version
6+
7+
We first change the version of the code :
8+
```cmake
9+
set(SHAMROCK_VERSION_MAJOR 2024)
10+
set(SHAMROCK_VERSION_MINOR 10)
11+
set(SHAMROCK_VERSION_PATCH 0)
12+
```
13+
Here the major version is the current year, and the minor version is the current month. Finally, the patch version indicate the minor release (bug fix or other).
14+
15+
## The release branch
16+
17+
First, if this is a true release (opposed to a patch), we branch from `main` and name it `release/<major>.<minor>.x`.
18+
19+
## The release workflow
20+
21+
We launch the `Prepare release` workflow on the release branch. This will generate the doc, the coverage info and the source code archive.
22+
23+
## Creating the release
24+
25+
We then draft a new release on GitHub. The tag must be set to `v<major>.<minor>.<patch>`, and we set the target branch to `release/<major>.<minor>.x`. Then set the release name to `Shamrock <major>.<minor>.<patch>`.
26+
27+
Then generate the release note from the last tag.
28+
29+
For the files, add the documentation, license, and coverage, named `Shamrock-<major>.<minor>.<patch>-<filename>`, except for the license file that will be named `LICENSE`.
30+
31+
Finally, write the text and ... done !

doc/mkdocs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ nav:
3434
- 'Develloper Doc' :
3535
- 'Git guide' : 'devdoc/git_guide.md'
3636
- 'VSCode setup' : 'devdoc/vscode-setup.md'
37+
- 'Release process' : 'devdoc/release_process.md'
3738
- 'Using the logs' : 'devdoc/log_system.md'
3839
- 'Local LLVM' : 'devdoc/using_local_llvm.md'
3940
- 'Codebase Organisation' : 'devdoc/codebase_org.md'

0 commit comments

Comments
 (0)