Skip to content

Enforce Changelog Updates

Request changes if a PR that meets specified criteria lacks an update to the project's changelog.

Review Changelog

Configuration Description

Conditions (All must be true):

  • The branch name contains the phrase feature
  • The PR lacks changes to the docs/changelog.md file

Automation Actions:

  • Apply a yellow label that says ⚠️ Missing Changelog
  • Request changes and post a comment explaining why.

Review Changelog

# -*- mode: yaml -*-
manifest:
  version: 1.0
automations:
  # Request changes for new features that lack changelog updates.
  review_changelog: 
    if: 
      - {{ branch.name | includes(term="feature") }}
      - {{ files | match(regex=r/^docs\/changelog\.md$/) | nope }}
    run:
      - action: add-label@v1
        args:
          label: "⚠️ Missing Changelog"
          color: {{ colors.yellow }}
      - action: add-comment@v1
        args: 
          comment: | 
            All new features require an update to the changelog. Please modify your PR to include any relevant changelog updates.

colors:
  yellow: 'fbca04'
Download this example as a CM file.

Special thanks to Boemo W Mmopelwa for providing this example.

Additional Resources

gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.

Learn More about how gitStream Works.

Related Automations:

More Automations can be found on the Automation Library and Integrations pages.