Skip to content

Commit

Permalink
Automate release notes generation (#368)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvothecoder committed Oct 18, 2022
1 parent 8cc9054 commit 778b498
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name-template: "v$RESOLVED_VERSION"
tag-template: "v$RESOLVED_VERSION"
autolabeler:
- label: "Type: Enhancement"
branch: '/feature\/.+/'
- label: "Type: Bug"
branch: '/(bug)?fix\/.+/'
title: "/fix/i"
- label: "Type: Documentation"
files: "*.rst"
branch: '/docs{0,1}\/.+/'
- label: "Type: DevOps"
branch: '/devops\/.+/'
categories:
- title: "Features"
labels: "Type: Enhancement"
- title: "Bug Fixes"
labels: "Type: Bug"
- title: "Documentation"
label: "Type: Documentation"
- title: "DevOps"
label: "Type: DevOps"
change-template: "- $TITLE by @$AUTHOR in $URL"
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
exclude-labels: "skip-changelog"
version-resolver:
major:
labels:
- "major"
minor:
labels:
- "minor"
patch:
labels:
- "patch"
default: patch
template: |
## Changes
$CHANGES
footer: |
**Full Changelog**: https://github.com/xCDAT/xcdat/compare/$PREVIOUS_TAG...$RESOLVED_VERSION
29 changes: 29 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Release Drafter

on:
push:
# branches to consider in the event; optional, defaults to all
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]

permissions:
contents: read

jobs:
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
# 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 }}

0 comments on commit 778b498

Please sign in to comment.