post-release

post-release

post-release - Post-release cleanup chores, intended to be triggered by publishing a release

This action is designed to be triggered by publishing a release. On completion, it will open a pull request to merge post-release clean up chores such as bumping the developemnt version in the version file and changelog. It works best when used in conjunction with draft-release to help automate parts of the release process.

Usage

Required files:

• CHANGELOG.md - a changelog or news file with entries in reverse chronological order. The newest entry should contain “development header”.
• VERSION - a single-source version file.
• CITATION.cff - a citation file. (optional)

Basic example

post-release.yml

name: post-release

on:
  release:
    types:
      - published

jobs:
  cleanup:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: CCBR/actions/[email protected]
        with:
          github-token: ${{ github.token }}

Customized inputs

steps:
  - uses: actions/checkout@v4
    with:
      fetch-depth: 0
  - uses: CCBR/actions/post-release@main
    with:
      github-token: ${{ github.token }}
      ccbr-actions-version: main
      python-version: 3.11
      pr-branch: release/${{ github.ref_name }}
      draft-branch: release-draft
      version-filepath: VERSION
      changelog-filepath: CHANGELOG.md
      citation-filepath: CITATION.cff
      dev-header: "development version"
      github-actor: "41898282+github-actions[bot]"
      update-sliding-branch: false

Inputs

• github-token: GitHub Actions token (e.g. github.token). Required.
• ccbr-actions-version: The version of CCBR/actions to use. Required. Default: main.
• python-version: The version of Python to install. Required. Default: 3.11.
• pr-branch: Branch to use for the post-release chores, from where a PR will be opened. Recommended to use ‘release/{TAG_NAME}’. Required. Default: release/${{ github.ref_name }}.
• draft-branch: Branch used for the prior release draft (see draft-release action). Required. Default: release-draft.
• version-filepath: Path to the file containing the current version. Default: VERSION.
• changelog-filepath: Path to the changelog or news file. Default: CHANGELOG.md.
• citation-filepath: Path to the citation file. Default: CITATION.cff.
• dev-header: Header string to match to find the development version entry in the changelog, typically of the form ‘## development version’. Default: development version.
• github-actor: Username of GitHub actor for the git commit when the docs branch is deployed. Required. Default: 41898282+github-actions[bot].
• update-sliding-branch: Whether to update the sliding branch (major.minor) to the new patch version. Default: false.