Changelogg

Automate your Pull Requests to Changelogs Generation Flow.

An easy-to-setup GitHub app to generate changelogs from merged pull requests and to help you gain insights from it.

Installation Steps

• Install Changelogg GitHub app to your account or organization from here.
• Select repositories for which you would like to activate Changelogg.
• Login to Changelogg dashboard to checkout dashboard and insights.

Key Features

• Intuitive dashboard to keep track of changelogs history, release versions, etc.

• Provide advanced filtering options to extract desired changelogs

• Derive insights and metrics from your changelogs

• Keep different versions of changelogs depending on branches

• Create a public link for changelogs which can be shared with everyone and can be used as an audit log
  

Application logic

Only PRs that get merged and have valid changelogs info will be automatically exported to Changelogg platform. The usual flow will be as follows:

1. The author opens a PR from a feature branch.
2. The author adds changelogs content with suitable tags (reference below).
   
3. The reviewer or author merges the PR.
4. Login to Changelogg to see and manage generated changelogs and get insights.

The following flow doesn't result in changelog generation:

• The reviewer or author decides to close the PR without merging it.

Valid tags:

• added
• changed
• deprecated
• fixed
• removed
• security

Template

Please add changelogs in below format in the PR description:

- (tag) changelog_text

Example:

## Changelogs
- (added) X is live now
- (changed) Y is changed now
- (deprecated) Z is deprecated
- (fixed) A is squashed 
- (removed) B refactored
- (security) releasing a security patch for C
- (added) D is live too

Installation

Want to try it out? You can install the app directly from this page.

Feedback?

Let's Make Changelogs Great Again!
Please open an issue here.

What’s the point of a changelog?

To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

Why should I care?

Because software tools are for people. "Changelogs make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project."
keepachangelog

References

• Github-changelog-generator