Skip to content

Commit f219b69

Browse files
Release process docs (#248)
* Doc of the new release process using GH actions and cleanup of the old release scripts Signed-off-by: Francesco Guardiani <francescoguard@gmail.com> * Nit Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
1 parent 3cea024 commit f219b69

File tree

5 files changed

+14
-120
lines changed

5 files changed

+14
-120
lines changed

.github/workflows/master.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
java-version: ${{ matrix.java }}
2121
- run: |
2222
mvn clean install -DskipTests -B
23-
mvn verify
23+
mvn verify -B
2424
deploy:
2525
runs-on: ubuntu-latest
2626
name: Deploy

.github/workflows/pr.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ jobs:
2020
java-version: ${{ matrix.java }}
2121
- run: |
2222
mvn clean install -DskipTests -B
23-
mvn verify
23+
mvn verify -B

maintainer_guidelines.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Maintainer's Guide
22

3+
## Release Process
4+
5+
The release process is automated with Github actions. In order to perform a release:
6+
7+
1. Check if master CI pass.
8+
1. Open the Github repository main page and go in the tab "Actions". Trigger the workflow "Bump version" and insert the new version to release. This will create a new release PR.
9+
1. Check the release PR, merge it and cleanup the created branch.
10+
1. Wait for the CI to complete the deploy of the modules to OSSRH.
11+
1. Using the Github UI, create a new release, specifying the release notes and the tag to use.
12+
1. Trigger again the workflow "Bump version" to bump versions back to a snapshot version.
13+
1. Check the snapshot release PR, merge it and cleanup the created branch.
14+
315
## Tips
416

517
Here are a few tips for repository maintainers.

scripts/release.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

scripts/trigger_release.sh

Lines changed: 0 additions & 94 deletions
This file was deleted.

0 commit comments

Comments
 (0)