Replace get_changes in dev with custom solution for automating changelog updates #2659
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Our current solution for automating changelog updates relies on a fork of an external project and does not format entries correctly or provide all the data we need about changes.
Solution
This custom solution uses PyGithub to get all pulls since a specified tag, bot version bumps excepted, and formats them like existing entries in the log. It also supplies a release title with a correctly formatted URL, includes one-line descriptions if provided by authors, and more. Also included: a method for getting new contributors, an updated README and requirements.txt, and updated .gitignore.
One-line summary: replaces get_changes in dev with custom solution
Checklist
CHANGELOG.md
(Depending on the change, this may not be necessary)..sql
database schema migration according to Flyway's naming convention (if relevant)