Maintain a changelog - Githubissues

bkeepers commented 6 years ago

Via @benbalter in https://github.com/probot/probot/issues/15

When a pull request is merged, add a line to CHANGELOG.md or HISTORY.md, with the PR title, number, and if the contributor is not a maintainer, give them props, optionally categorizing the updates based on tags.

@jekyllbot does this (with a slightly different behavior that I don't like), but the end result could look somethign like this:

## Head

### Minor

* Make the button red (#123, props @bkeepers)

### Major

* Button is now a switch (#456)

### Development

* Add Rubocop (#789)

bkeepers commented 6 years ago

@JasonEtco added in https://github.com/probot/template/issues/4#issuecomment-331011832:

Might also be worth looking into how semantic-release does this. Setting it up is a bit of a mystery to me, but I like their convention of prefixing commits with certain keywords, then organizing the resulting release post by those keywords. So:

Commits:

fix: Fixed a bug
perf: Made commenting 100x faster

CHANGELOG.md:

## Head

### Bug fixes

- Fixed a bug, SHA (or #123)

### Performance Improvements

- Made commenting 100x faster, SHA

ibrahima commented 6 years ago

This might be related, although I haven't yet looked through the code to figure out what it actually does. But it seems likely to do something like this: https://github.com/uber-workflow/probot-app-release-notes

GitHub
uber-workflow/probot-app-release-notes
probot-app-release-notes - Sets GitHub release notes based on changes

Ah, after some perusal it looks like probot-app-release-notes does generate Github release notes based on the PR titles and labels applied. Seems like it does do almost exactly what's described in this issue! Although for a second I thought that the idea behind this issue was to include an actual section of the PR body that would have the changelog entry, which would allow more detailed entries, but title is probably best to keep things simple (the details are in the PR link anyway).

mikz commented 6 years ago

I made https://github.com/mikz/probot-changelog It lacks a readme and tests, but I'm successfully using it on https://github.com/3scale/apicast.

It does not check any specific format, just that changelog changed.

GitHub
mikz/probot-changelog
probot-changelog - A GitHub Integration that checks Pull Requests and verifies CHANGELOG changed when modifying application code.

GitHub
3scale/apicast
apicast - 3scale api gateway reloaded

mukul13 commented 4 years ago

Hi, I have created a github app to maintain changelog: PRCLbot

It currently follows the format of keepachangelog

Landing Page: PRCLbot

It also has additional features like

Slack Integration for each repo
Intuitive dashboard to keep track of changelog history, release versions, etc
Project Insights (like changelog pattern over time, bug to feature ratio etc)
Option to Publish changelog to share your progress with everyone

gr2m commented 4 years ago

This looks really cool @mukul13!

probot / ideas

Maintain a changelog #7