Skip to content

Commit

Permalink
🧑‍💻 Draft release notes with GitHub Actions
Browse files Browse the repository at this point in the history
Automating the changelog writing with Release Drafter probot! Template and workflow based on PyGMT, but with emojis.
  • Loading branch information
weiji14 committed Jun 7, 2022
1 parent 15c99db commit 63f318a
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/release-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name-template: 'v$RESOLVED_VERSION 🌈'
tag-template: 'v$RESOLVED_VERSION'
categories:
- title: '🚀 Features'
label: 'feature'
- title: '🐛 Bug Fixes'
label: 'bug'
- title: '📖 Documentation'
label: 'documentation'
- title: '🧰 Maintenance'
label: 'maintenance'
version-resolver:
minor:
labels:
- 'feature'
default: patch
exclude-labels:
- 'skip-changelog'
category-template: '### $TITLE'
change-template: '* $TITLE ([#$NUMBER]($URL))'
template: |
## Release v$RESOLVED_VERSION (20YY/MM/DD)
### 💫 Highlights
*
$CHANGES
### 🧑‍🤝‍🧑 Contributors
$CONTRIBUTORS
21 changes: 21 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Release Drafter

on:
push:
branches:
- main

permissions:
contents: read

jobs:
update_release_draft:
runs-on: ubuntu-22.04
steps:
# Drafts your next Release notes as Pull Requests are merged into "main"
- uses: release-drafter/release-drafter@v5.20.0
with:
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
config-name: release-template.yml
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit 63f318a

Please sign in to comment.