Skip to content

Commit 4dcd33c

Browse files
committed
Add PR template + git log commands
Signed-off-by: Olivier Perrin <[email protected]>
1 parent 40f7403 commit 4dcd33c

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

BRANCHING_RELEASE_STRATEGY.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,22 @@ $ git push -u origin tmp_prepare_release
154154
$ # Then create a PR for tmp_prepare_release
155155
```
156156

157-
Create a pull request from your temporary branch into the `main` branch.
157+
Create a pull request from your temporary branch into the `main` branch.
158+
In its description, use the following message (don't forget to change the vX.Y.0 by your version number):
159+
```markdown
160+
**Please check if the PR fulfills these requirements**
161+
<!-- please use `'[x]'` to check the checkboxes, or submit the PR and then click the checkboxes -->
162+
- [X] The commit message follows our guidelines
163+
164+
165+
**What kind of change does this PR introduce?**
166+
<!-- Bug fix, feature, docs update, ... -->
167+
Prepare release vX.Y.0
168+
169+
**Other information**:
170+
:warning: **DO NOT** squash the commits, merge with fast-forward locally
171+
```
172+
158173
Wait until all the CI criteria are fully validated. Then add a commit for your next snapshot version.
159174
You can then push again.
160175

@@ -176,6 +191,8 @@ $ git push
176191
```
177192
After that, create your tag:
178193
```shell
194+
$ git log --oneline -2
195+
$ # Retrieve the commit hash of the second line, and use it in the following instruction
179196
$ git tag -s vX.Y.0 <hash of the corresponding commit (bumping to vX.Y.0)>
180197
$ git push origin vX.Y.0
181198
```
@@ -194,6 +211,8 @@ On your repository, checkout to the release tag. You can then package and deploy
194211
$ git status
195212
$ # Your local repository should be clean
196213
$ git checkout tags/vX.Y.0
214+
$ git log --oneline -1
215+
$ # Check that the last commit is indeed the "Bump to X.Y.0" commit
197216
$ mvn dependency:purge-local-repository
198217
$ mvn clean package -Prelease
199218
$ mvn deploy -Prelease -DskipTests

0 commit comments

Comments
 (0)