GitHub Action - Add To Changelog

This GitHub action prepends the release note from the PR body to the CHANGELOG.md file. It then commits and pushes the file.

Inputs

• version: The version released
• body: The main text to add to the changelog
• pr-url: URL to the PR that resulted in the release
• changelog-path: Path to the CHANGELOG.md file. Defaults to CHANGELOG.md in repo root.
• user-email: The email of the user that should commit the CHANGELOG
• user-name: The name of the user that should commit the CHANGELOG
• token: The token used to push the commit. Defaults to ${{ secrets.GITHUB_TOKEN }}

Example Workflow

on:
  push:
    branches:
    - '**'
  pull_request:
    types: [closed]

name: GitHub action workflow name

jobs:
  context:
    name: Job name
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Setup node v12
      uses: actions/setup-node@v1
      with:
        node-version: 12.x
    - run: yarn
    - run: yarn release

    # this outputs the PR body
    - name: Establish context
      id: context
      uses: dolittle/establish-context-action@v2

    - name: Increment version
      id: increment-version
      if: ${{ steps.context.outputs.should-publish == 'true' }}
      uses: dolittle/increment-version-action@v2
      with:
        version: ${{ steps.context.outputs.current-version }}
        release-type: ${{ steps.context.outputs.release-type }}

    - name: Prepend to Changelog
      if: ${{ steps.context.outputs.should-publish == 'true' }}
      uses: dolittle/add-to-changelog-action@v2
      with:
        version: ${{ steps.increment-version.outputs.next-version }}
        # input for the text to prepend to
        body: ${{ steps.context.outputs.pr-body }}
        pr-url: ${{ steps.context.outputs.pr-url }}
        # path to changelog
        changelog-path: CHANGELOG.md
        # for committing and pushing
        user-email: [email protected]
        user-name: some-name
        token: ${{ github.token }}

    - name: Create GitHub Release
      if: ${{ steps.context.outputs.should-publish == 'true' }}
      uses: dolittle/github-release-action@v2
      with:
        token: ${{  secrets.BUILD_PAT  }}
        version: ${{ steps.increment-version.outputs.next-version }}
        body: ${{ steps.context.outputs.pr-body }}

Contributing

We're always open for contributions and bug fixes!

Pre requisites

node <= 12 yarn git