After installation this action will check that the files in a pull request contain a changelog. If the changelog is not present, the action will create the comment:
The test for changelog defaults to the regex /change_log\/.*\/*.yml
change_log/next/RU-3456.yml✅changelog/RU-3456.yml❌
But you can supply your regex for changelogs (see example below)
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]
with:
changelog_regex: '/change_log\/.*\/*.yml'
customPrMessage: 'You broke regulation TO-67!'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}