Install Now

Chronicler adds a check to your GitHub pull requests, which fails if production code was changed without a matching update to the release notes

Tell The World

Let people visiting your project know that you keep your changelogs up-to-date with this badge! Here are some samples for adding it to a README

Badge image generated using shields.io

README.md:

[![Changelog validated by Chronicler](https://chronicler.starchartlabs.org/images/changelog-chronicler-success.png)](https://chronicler.starchartlabs.org/)


HTML:

<a href="https://chronicler.starchartlabs.org/">
  <img src="https://chronicler.starchartlabs.org/images/changelog-chronicler-success.png" alt="Changelog validated by Chronicler">
</a>


reStructuredText:

.. image:: https://chronicler.starchartlabs.org/images/changelog-chronicler-success.png
    :target: https://chronicler.starchartlabs.org/
    :alt: Changelog validated by Chronicler

Configuration

You can configure Chronicler to customize what is considered a production file and what is considered a release notes file. Create a YAML file at /.starchart-labs/chronicler.yml in your repository. This is not required, and the default values, shown below, have been selected to cover general cases.

productionFiles:
   include:
      - '**/src/**'
   exclude:
      - '**/test/**'
releaseNoteFiles:
   include:
      - '**/CHANGE*LOG*'
      - '**/RELEASE*NOTES*'

The configuration shown is the default values. Here is the YAML structure supported for configuration:

  • productionFiles - Describes what files to consider as production files
    • include - A list of case-insensitive patterns to consider as production files
    • exclude - A list of case-insensitive patterns to exclude from production files
  • releaseNoteFiles - Describes what files to consider as release notes files
    • include - A list of case-insensitive patterns to consider as release notes files
    • exclude - A list of case-insensitive patterns to exclude from release notes files

All patterns from the instructions above are Java PathMatcher Glob Syntax