Skip to content

Commit 27f3775

Browse files
authored
doc: Rearrange release doc
Signed-off-by: Christopher Lepski <139237321+clepski@users.noreply.github.com>
1 parent ab26751 commit 27f3775

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/RELEASES.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
# Releasing software
22

3-
## Create a release
4-
5-
### Backend services
6-
7-
We are using [release please](https://github.com/googleapis/release-please) which automatically creates and updates a release PR. The PR contains an up to date changelog based on the conventional commit messsages and sets the new version number. To trigger a release the release please PR has to be merged, which triggers the release please workflow (currently the release please PR has to be merged twice, because it creates a snapshot version first). The workflow will build the Maven packages, upload them to GitHub packages and build the Docker image and upload it to Docker hub.
8-
9-
### Compas open scd
3+
## Release Compas open scd
104

115
In the compas-open-scd repository, update the version number in packages/compas-open-scd/package.json and make sure the submodule pointers are correct. Go to https://github.com/com-pas/compas-open-scd. Under releases click Draft a new release. In Choose a tag, create a new tag using the new version number. Click Generate release notes — review the notes and ensure they’re correct.
126

137
Publishing the release will trigger a Github workflow and build the Docker image and upload it to Docker hub.
148

9+
## Release backend service
10+
11+
We are using [release please](https://github.com/googleapis/release-please) which automatically creates and updates a release PR. The PR contains an up to date changelog based on the conventional commit messsages and sets the new version number. To trigger a release the release please PR has to be merged, which triggers the release please workflow (currently the release please PR has to be merged twice, because it creates a snapshot version first). The workflow will build the Maven packages, upload them to GitHub packages and build the Docker image and upload it to Docker hub.
12+
1513
## Publish artifacts using Maven
1614

1715
To publish artifacts to GiHub Packages a distribution section needs to be added to pom.xml of the root.

0 commit comments

Comments
 (0)