48 lines
1.7 KiB
YAML
48 lines
1.7 KiB
YAML
# This workflow automates the creation and updating of draft releases. It compiles PR titles into the draft release notes.
|
|
# https://github.com/ZcashFoundation/zebra/releases
|
|
#
|
|
# - Updates the draft release upon each merge into 'main'.
|
|
# - Utilizes the release-drafter GitHub Action to accumulate PR titles since the last release into a draft release note.
|
|
# - Suitable permissions are set for creating releases and handling pull requests.
|
|
#
|
|
# Workflow is based on:
|
|
# https://github.com/marketplace/actions/release-drafter#usage
|
|
name: Release Drafter
|
|
|
|
on:
|
|
# Automatically update the draft release every time a PR merges to `main`
|
|
push:
|
|
branches:
|
|
- main
|
|
# 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]
|
|
# Manually update the draft release without waiting for a PR to merge
|
|
workflow_dispatch:
|
|
|
|
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
|
|
- uses: release-drafter/release-drafter@v5
|
|
with:
|
|
config-name: release-drafter.yml
|
|
commitish: main
|
|
#disable-autolabeler: true
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|