Skip to content

Commit

Permalink
Automate GitHub Releases when new tags are pushed (#8626)
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobtomlinson authored Jun 13, 2024
1 parent af237f0 commit d8dc8ad
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These will be overridden by the publish workflow and set to the new tag
name-template: 'Next Release'
tag-template: 'next'

change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.

template: |
## Changes
$CHANGES
See the [Changelog](https://docs.dask.org/en/stable/changelog.html) for more information.
32 changes: 32 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Release Drafter

on:
push:
branches:
- main

permissions:
contents: read

jobs:
update_release_draft:
if: github.repository == 'dask/distributed'
permissions:
# Write permission is required to create a GitHub release
contents: write
pull-requests: read
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Required to get tag history
- name: Check if release commit
id: check_release_commit
run: git describe --exact-match --tags $(git rev-parse HEAD)
continue-on-error: true
- uses: release-drafter/release-drafter@v6
if: steps.check_release_commit.outcome != 'success'
with:
disable-autolabeler: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33 changes: 33 additions & 0 deletions .github/workflows/release-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Release Publisher

on:
push:
tags:
- "*.*.*"

permissions:
contents: read

jobs:
publish_release:
if: github.repository == 'dask/distributed'
permissions:
# Write permission is required to publish a GitHub release
contents: write
pull-requests: read
runs-on: ubuntu-latest
steps:
- name: Set version env
# Use a little bit of bash to extract the tag name from the GitHub ref
run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
- uses: release-drafter/release-drafter@v5
with:
disable-autolabeler: true
# Override the Release name/tag/version with the actual tag name
name: ${{ env.RELEASE_VERSION }}
tag: ${{ env.RELEASE_VERSION }}
version: ${{ env.RELEASE_VERSION }}
# Publish the Release
publish: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 comments on commit d8dc8ad

Please sign in to comment.