Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve changelog workflow #19

Closed
badsyntax opened this issue May 13, 2020 · 3 comments · Fixed by #24
Closed

Improve changelog workflow #19

badsyntax opened this issue May 13, 2020 · 3 comments · Fixed by #24
Assignees
Labels
enhancement New feature or request

Comments

@badsyntax
Copy link
Owner

I added a mergeability app to check for changelog changes but this breaks CI when dependabot sends dep updates. As we're using GitHub releases & release drafter we don't need to keep a separate changelog updated.

  • remove the mergability app
  • update CHANGELOG.md to link to the releases page
@nedtwigg
Copy link

A brief plug for a related approach: https://github.com/diffplug/spotless-changelog

One of the things that project can do is machine-parse a changelog. It's not built, but if you wanted to turn GitHub release metadata into a CHANGELOG.md, or vice-versa, all the changelog parsing / building code is in there, it would just need to get hooked into the GitHub APIs. The only advantage imo of GitHub release metadata is API, at the cost of platform-lockin. Standardized CHANGELOG.md gives you a broader and faster API without lockin.

@badsyntax
Copy link
Owner Author

I was never comfortable with removing the data from the CHANGELOG but found it to be a maintenance burden to keep the GitHub releases and the CHANGELOG in sync. Having an automated process would be ideal. I'll check this out when I got some time 👍

@nedtwigg
Copy link

I've added an issue for the specific topic of GitHub integration if you'd like to ignore broader noise on the project in favor of just this topic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants