Skip to content

Commit

Permalink
Automate release note genreation (#400)
Browse files Browse the repository at this point in the history
* Use release-drafter only for PR labeling

* Remove release note config

* Generate a new release note with a new tag
  • Loading branch information
xerial authored May 16, 2023
1 parent 5b879bf commit 9125550
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 49 deletions.
39 changes: 0 additions & 39 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,42 +1,3 @@
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
categories:
- title: '🔥 Breaking Changes'
labels:
- 'breaking'
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'bug'
- title: '👋 Deprecated'
labels:
- 'deprecation'
- title: '🔗 Dependency Updates'
labels:
- 'library-update'
- 'dependencies'
- title: '🛠 Internal Updates'
labels:
- 'internal'
- 'kaizen'
- 'test-library-update'
- 'sbt-plugin-update'
- title: '📚 Docs'
labels:
- 'doc'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'

template: |
## What's Changed
$CHANGES
**Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
autolabeler:
- label: 'doc'
files:
Expand Down
31 changes: 31 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
changelog:
categories:
- title: '🔥 Breaking Changes'
labels:
- 'breaking'
- title: '👋 Deprecated'
labels:
- 'deprecation'
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'bug'
- title: '🔗 Dependency Updates'
labels:
- 'library-update'
- 'dependencies'
- title: '🛠 Internal Updates'
labels:
- 'internal'
- 'kaizen'
- 'test-library-update'
- 'sbt-plugin-update'
- title: '📚 Docs'
labels:
- 'doc'
- title: Other Changes
labels:
- "*"
12 changes: 2 additions & 10 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
name: Release Drafter

on:
push:
branches:
- master
# pull_request event is required only for autolabeler
pull_request:
# Only following types are handled by the action, but one can default to all as well
types: [opened, reopened, synchronize]
# pull_request_target event is required for autolabeler to support PRs from forks
pull_request_target:
types: [opened, reopened, synchronize]


permissions:
contents: read

jobs:
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
contents: read
# write permission is required for autolabeler
# otherwise, read permission is required at least
pull-requests: write
runs-on: ubuntu-latest
steps:
# Drafts your next Release notes as Pull Requests are merged into "master"
- uses: release-drafter/release-drafter@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18 changes: 18 additions & 0 deletions .github/workflows/release-note.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Release Note

on:
push:
tags:
- v*
workflow_dispatch:

jobs:
release:
name: Create a new release note
runs-on: ubuntu-latest
steps:
- name: Create a release note
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh release create "$GITHUB_REF_NAME" --repo="$GITHUB_REPOSITORY" --generate-notes
2 changes: 2 additions & 0 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Release Notes
===

See [the release note page](https://github.com/xerial/sbt-sonatype/releases) for the latest release notes.

# 3.9.14

- Upgraded airframe-http to 22.11.0
Expand Down

0 comments on commit 9125550

Please sign in to comment.