Skip to content

Commit fe690e2

Browse files
karabowiChristianTackeGSI
authored andcommitted
Add information on release process
1 parent cbc1fcf commit fe690e2

1 file changed

Lines changed: 36 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,20 @@ for (auto const& volume : *volumes) { /*...*/ } // ✓ prefer
109109
```
110110
111111
112-
# Creating a new Release
112+
## R - Creating a new Release
113113
114114
(This is basically for the release manager, so that we don't
115115
forget anything.)
116116
117-
* Take a look at the
118-
[Milestone](https://github.com/FairRootGroup/FairRoot/milestones)
119-
for the release
117+
### R.1 Control the status
120118
121-
Consider moving still open items to another milestone
119+
Take a look at the [Milestone](https://github.com/FairRootGroup/FairRoot/milestones) for the release.
120+
121+
Consider moving still open items to another milestone
122+
123+
### R.2 Create a commit
124+
125+
On the `v{x.y}_patches` branch with comment `Bump v{x.y.z}`:
122126
123127
* Double check that the version number on the `project`
124128
line in [CMakeLists.txt](CMakeLists.txt) is correct
@@ -132,6 +136,33 @@ forget anything.)
132136
133137
* Apply editorial changes to [README](README.md)
134138
139+
### R.3 Push the patch to the repository:
140+
141+
```
142+
git push origin v{x.y}_patches
143+
```
144+
145+
### R.4 Create, control and push the new tag to the repository:
146+
147+
```
148+
git tag v{x.y.z} -a -s
149+
git show v{x.y.z}
150+
git push origin v{x.y.z}
151+
```
152+
153+
### R.5 Create a new realese on GitHub.
154+
155+
### R.6 In certain cases the tag should be merged onto master:
156+
157+
```
158+
git checkout master
159+
git merge origin/v{x.y}_patches
160+
git push mainrepo origin
161+
```
162+
163+
The message, when prompted, should be `Merge v{x.y.z}`.
164+
The merge and push should not be forced.
165+
135166
* …
136167
137168
* (Soon)

0 commit comments

Comments
 (0)