Skip to content
This repository was archived by the owner on Apr 12, 2026. It is now read-only.

Commit 8dc9626

Browse files
committed
Add Release Drafter
We are now using the Release Drafter to generate the changelog for new releases. For that reason we are also removing the CHANGELOG.md file, so that users do not have to add manuall entries to the changelog. The changelog is generated based on the following labels: "changelog: added", "changelog: fixed" and "changelog: changed". One of these labels must be added to a PR.
1 parent 2f49729 commit 8dc9626

6 files changed

Lines changed: 58 additions & 480 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!--
22
Keep PR title verbose enough and add prefix telling about what plugin it touches e.g "[prometheus]" or "[app]"
3+
4+
If you add a breaking change within your PR you should add ":warning:" to the title, e.g. ":warning: [app] My breaking change"
35
-->
46

57
<!--
@@ -13,6 +15,5 @@
1315
- [#<PR-ID>](<PR-URL>): [<PLUGIN>] ...
1416
-->
1517

16-
- [ ] I added a [CHANGELOG](https://github.com/kobsio/kobs/blob/master/CHANGELOG.md) entry for this change.
1718
- [ ] I adjusted the corresponding [documentation](https://github.com/kobsio/kobs/tree/main/docs) for this change.
1819
- [ ] I adjusted the [values.yaml](https://github.com/kobsio/kobs/blob/main/deploy/helm/kobs/values.yaml) file and the [documentation for all values](https://github.com/kobsio/kobs/blob/main/docs/installation/helm.md).

.github/release.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name-template: "$RESOLVED_VERSION"
2+
tag-template: "$RESOLVED_VERSION"
3+
version-template: "v$MAJOR.$MINOR.$PATCH"
4+
categories:
5+
- title: "Added"
6+
labels:
7+
- "changelog: added"
8+
- title: "Fixed"
9+
labels:
10+
- "changelog: fixed"
11+
- title: "Changed"
12+
labels:
13+
- "changelog: changed"
14+
version-resolver:
15+
minor:
16+
labels:
17+
- "changelog: added"
18+
- "changelog: changed"
19+
patch:
20+
labels:
21+
- "changelog: fixed"
22+
default: patch
23+
category-template: "### $TITLE"
24+
change-template: '- #$NUMBER: $TITLE @$AUTHOR'
25+
template: |
26+
$CHANGES
27+
replacers:
28+
- search: ':warning:'
29+
replace: ':warning: _Breaking change:_ :warning:'

.github/workflows/release.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
changelog:
13+
permissions:
14+
contents: write
15+
pull-requests: write
16+
name: Changelog
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Update Changelog
20+
uses: release-drafter/release-drafter@v5
21+
with:
22+
config-name: release.yaml
23+
disable-autolabeler: true
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)