Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check

GitHub Action

Changelog Reminder

v1.0.1

Changelog Reminder

check

Changelog Reminder

If there is not a changelog in the PR add a comment to remind the committer

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Changelog Reminder

uses: peterjgrainger/[email protected]

Learn more about this action in peterjgrainger/action-changelog-reminder

Choose a version

GitHub action to add a changelog reminder

After installation this action will check that the files in a pull request contain a changelog. If it doesn't it will create the comment:

changelog_comment

The log must be a .yml file and be at any depth in a folder named change_log

The test for this is a regex /change_log\/.*\/*.yml

  • change_log/next/RU-3456.yml
  • changelog/RU-3456.yml

Installation

To configure the action simply add the following lines to your .github/workflows/rebase.yml workflow file:

on: pull_request
name: Changelog Reminder
jobs:
  remind:
    name: Changelog Reminder
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Changelog Reminder
      uses: peterjgrainger/[email protected]
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}