Skip to content

feat(parsers): enable parsers to identify linked issues on a commit #1109

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

Conversation

codejedi365
Copy link
Contributor

@codejedi365 codejedi365 commented Nov 30, 2024

Purpose

  • Add functionality to built-in parsers to parse out issue references from commit messages

Rationale

This adds essential functionality for PSR to extract issue closure references defined in commits and include them in the Parsed Commit object. This then allows consumers custom changelog to display issue information as desired.

I did not add a default method to display closed issues in the default changelog as I have not decided on a standard format that would be accepted by the community. Only time will tell. The custom changelog for PSR will have a different format for the changelog than the release notes, so we will see if people request a specific default to be added.

How did you test?

Added a significant number of parameterized values to attempt to test all boundaries of different variations of git footer usage of closure statements. The closure statements are all defined by the different VCS hosting platforms.

How to Verify

  1. Checkout this pr
  2. Reset by 7 commits to remove the fix
  3. Run pytest to see the failures on issues that are not identified
  4. Fast forward merge to the latest commit of this pr
  5. Run pytest again to see it is fixed.

@codejedi365 codejedi365 force-pushed the feat/parse-linked-issues branch 3 times, most recently from d7cc922 to 3423651 Compare December 1, 2024 23:30
@codejedi365 codejedi365 force-pushed the feat/parse-linked-issues branch from 3423651 to 263bce6 Compare December 2, 2024 00:12
@codejedi365 codejedi365 force-pushed the feat/parse-linked-issues branch 2 times, most recently from b74f944 to 23e2689 Compare December 2, 2024 00:37
@codejedi365 codejedi365 merged commit f90b8dc into python-semantic-release:master Dec 2, 2024
12 checks passed
@codejedi365 codejedi365 deleted the feat/parse-linked-issues branch December 2, 2024 00:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant