Skip to content

Commit 2e2deab

Browse files
committed
chore(ci): Add semantic-release workflow
1 parent 4431a95 commit 2e2deab

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Semantic Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- release/*
8+
9+
jobs:
10+
semantic-release:
11+
uses: radiorabe/actions/.github/workflows/[email protected]
12+
secrets:
13+
RABE_ITREAKTION_GITHUB_TOKEN: ${{ secrets.RABE_ITREAKTION_GITHUB_TOKEN }}

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Next:
1818

1919
docker-compose up -d next
2020

21-
2221
# Maintenance Mode
2322
In the .env file set NEXT_PUBLIC_MAINTENANCE_MODE true
2423

@@ -27,3 +26,30 @@ Next:
2726
redirect data.rabe.ch auf rabe.ch
2827

2928
disable healthcheck for next instance
29+
30+
# Release Management
31+
32+
The CI/CD setup uses semantic commit messages following the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/).
33+
The workflow is based on the [RaBe shared actions](https://radiorabe.github.io/actions/)
34+
and uses [go-semantic-commit](https://go-semantic-release.xyz/)
35+
to create new releases.
36+
37+
The commit message should be structured as follows:
38+
39+
```
40+
<type>[optional scope]: <description>
41+
42+
[optional body]
43+
44+
[optional footer(s)]
45+
```
46+
47+
The commit contains the following structural elements, to communicate intent to the consumers of your library:
48+
49+
1. **fix:** a commit of the type `fix` patches gets released with a PATCH version bump
50+
1. **feat:** a commit of the type `feat` gets released as a MINOR version bump
51+
1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:` gets released as a MAJOR version bump
52+
1. types other than `fix:` and `feat:` are allowed and don't trigger a release
53+
54+
If a commit does not contain a conventional commit style message you can fix
55+
it during the squash and merge operation on the PR.

0 commit comments

Comments
 (0)