Skip to content

Commit 2b15e9c

Browse files
committed
chore(ci): Add semantic-release workflow
1 parent 629243a commit 2b15e9c

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

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/semantic-release.yaml@v0.17.0
12+
secrets:
13+
RABE_ITREAKTION_GITHUB_TOKEN: ${{ secrets.RABE_ITREAKTION_GITHUB_TOKEN }}

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,30 @@ Directus:
1717
Next:
1818

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

0 commit comments

Comments
 (0)