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

Replace get_changes in dev with custom solution for automating changelog updates #2659

Merged
merged 4 commits into from
Oct 26, 2023

Conversation

merobi-hub
Copy link
Collaborator

@merobi-hub merobi-hub commented Oct 25, 2023

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.

Note: All database schema changes require discussion. Please link the issue for context.

One-line summary: replaces get_changes in dev with custom solution

Checklist

  • You've signed-off your work
  • Your changes are accompanied by tests (if relevant)
  • Your change contains a small diff and is self-contained
  • You've updated any relevant documentation (if relevant)
  • You've included a one-line summary of your change for the CHANGELOG.md (Depending on the change, this may not be necessary).
  • You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • You've included a header in any source code files (if relevant)

@netlify
Copy link

netlify bot commented Oct 25, 2023

Deploy Preview for peppy-sprite-186812 canceled.

Name Link
🔨 Latest commit 857c50d
🔍 Latest deploy log https://app.netlify.com/sites/peppy-sprite-186812/deploys/653a83bde14d67000816eaa6

@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

Merging #2659 (857c50d) into main (5c42dfd) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main    #2659   +/-   ##
=========================================
  Coverage     83.35%   83.35%           
  Complexity     1295     1295           
=========================================
  Files           244      244           
  Lines          5948     5948           
  Branches        279      279           
=========================================
  Hits           4958     4958           
  Misses          844      844           
  Partials        146      146           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@merobi-hub merobi-hub force-pushed the dev/changelog-script branch 2 times, most recently from 942f5d3 to 7c3298e Compare October 25, 2023 18:30
@wslulciuc wslulciuc merged commit 7565204 into main Oct 26, 2023
16 checks passed
@wslulciuc wslulciuc deleted the dev/changelog-script branch October 26, 2023 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants