Skip to content
/ chaas Public

GEUT LABS. Check if your changelog file has changed

License

Notifications You must be signed in to change notification settings

geut/chaas

Repository files navigation

chaas

Check if your CHANGELOG.md has changed.

A GitHub App built with Probot

chaas logo

Usage

chaas will run and check if your PR contains CHANGELOG changes.

Configuration

Add a .chaas.yml file to your project root if you need to modify any default configuration.

  • Options
    • version {Number}: chaas config schema version.
      • Default: 1.
    • ignore {Array}: A list of files/globs to ignore files in PRs. If your PR contains only files ignored then chaas will report as NEUTRAL.
      • Default: [].
      • example: If you don't want chaas to report when you only commit changes for markdown files:
          ignore: [ "**/*.md" ]
    • branches {Array}: A list of branches where chaas check should run if PRs are opened to merge into. Notice that if you specify this it overrides default configuration.
      • Default: [<Repository default branch>]. Usually master.
      • example: Run checks when PRs are created against master and canarybranches.
          branches: ["master", "canary"]

Development

# Install dependencies
npm install

# Run the bot (locally)
npm run dev 

Contributing

If you have suggestions for how chaas could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2019 GEUT contact@geutstudio.com (geutstudio.com)

Releases

No releases published

Packages

No packages published