Skip to content

Commit 3929eb3

Browse files
authored
internal: Automatically generate release notes (#766)
1 parent ba1beab commit 3929eb3

File tree

4 files changed

+52
-7
lines changed

4 files changed

+52
-7
lines changed

.github/release.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
changelog:
2+
categories:
3+
- title: '🔥 Breaking Changes'
4+
labels:
5+
- 'breaking'
6+
- title: '👋 Deprecated'
7+
labels:
8+
- 'deprecation'
9+
- title: '🚀 Features'
10+
labels:
11+
- 'feature'
12+
- 'enhancement'
13+
- title: '🐛 Bug Fixes'
14+
labels:
15+
- 'bug'
16+
- title: '🔗 Dependency Updates'
17+
labels:
18+
- 'library-update'
19+
- 'dependencies'
20+
- title: '🛠 Internal Updates'
21+
labels:
22+
- 'internal'
23+
- 'kaizen'
24+
- 'test-library-update'
25+
- 'sbt-plugin-update'
26+
- title: '📚 Docs'
27+
labels:
28+
- 'doc'
29+
- title: Other Changes
30+
labels:
31+
- "*"

.github/workflows/release-drafter.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
name: Release Drafter
22

33
on:
4-
push:
5-
branches:
6-
- main
74
# pull_request event is required only for autolabeler
85
pull_request:
96
# Only following types are handled by the action, but one can default to all as well
@@ -18,8 +15,7 @@ permissions:
1815
jobs:
1916
update_release_draft:
2017
permissions:
21-
# write permission is required to create a github release
22-
contents: write
18+
contents: read
2319
# write permission is required for autolabeler
2420
# otherwise, read permission is required at least
2521
pull-requests: write

.github/workflows/release-note.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Release Note
2+
3+
on:
4+
push:
5+
tags:
6+
- v*
7+
workflow_dispatch:
8+
9+
jobs:
10+
release:
11+
name: Create a new release note
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Create a release note
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17+
run: |
18+
gh release create "$GITHUB_REF_NAME" --repo="$GITHUB_REPOSITORY" --generate-notes

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,14 @@ Here is a list of sbt commands for daily development:
9696

9797
### Publish to Sonatype (Maven Central)
9898

99-
To publish a new version, you only need to add a new git tag and push it to GitHub. GitHub Action will deploy a new release version to Maven Central (Sonatype).
99+
To publish a new version, add a new git tag and push it to GitHub. GitHub Action will deploy a new release version to Maven Central (Sonatype).
100100

101101
```scala
102102
$ git tag v0.x.y
103103
$ git push origin v0.x.y
104104
```
105105

106-
A draft of the next release note will be updated automatically at the [GitHub Releases](https://github.com/msgpack/msgpack-java/releases) page. For each PR merged, [release-drafter](https://github.com/release-drafter/release-drafter) will modify the release note draft. When you create a new release tag, edit and publish the draft of the release note. If necessary, adjust the version number and target tag.
106+
A new release note will be generated automatically at the [GitHub Releases](https://github.com/msgpack/msgpack-java/releases) page.
107107

108108
#### Publishing to Sonatype from Local Machine
109109

0 commit comments

Comments
 (0)