Skip to content

Ability to easily autolink to PRs in changelogs #953

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

Closed
wyardley opened this issue Jun 15, 2024 · 6 comments · Fixed by #1091
Closed

Ability to easily autolink to PRs in changelogs #953

wyardley opened this issue Jun 15, 2024 · 6 comments · Fixed by #1091
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request

Comments

@wyardley
Copy link
Contributor

wyardley commented Jun 15, 2024

Description

It would be nice to have links to PRs (#123), such as when PRs are squash merged, be able to link to the GH issue vs. just linking to the commit. Way back, I tweaked this in #292, but seems like all of that has since been updated / revamped completely.

(it would also be nice to have a regex to be able to auto-populate links to ticketing systems via some kind of regex, kind of like GH autolinks, but less important)

I can see pull_request_url etc. here:
https://python-semantic-release.readthedocs.io/en/latest/changelog_templates.html
However, it would be nice to at least have some docs that include more examples of custom templates; also, I'm guessing the (#NNN) would also show up in the message itself unless it were edited out.

Use cases

This is also already supported out of the box in the original semantic-release implementation, and used to work in this project as well.

While I know there is templating, and would be happy to see a trivial solution to implement this natively with templating, my suggestion is that the resulting solution might be hard to read.

@wyardley wyardley added the feature A new feature or a feature request label Jun 15, 2024
@codejedi365
Copy link
Contributor

codejedi365 commented Jun 15, 2024

@wyardley, thank you for your request. I have been focused on improving changelogs as I have joined this project and have targeted this issue as well. Unfortunately, other higher priority items have prevented me from finishing my changelog refactors but I recommend you checkout PR #866 for what I have accomplished so far. It does include a MR/PR url replacement macro to do the item above. It might not be the end solution as people with other custom templates will loose out on the functionality unless they do a raw copy of the macros file.

You can also checkout the rest of the Better Changelogs milestone for other issues that target the same stuff you are interested in.

@codejedi365 codejedi365 added this to the Better Changelogs milestone Jun 15, 2024
@codejedi365 codejedi365 added the confirmed Prevent from becoming stale label Jun 15, 2024
Copy link

It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?

@github-actions github-actions bot added the needs-update Needs status update from maintainers label Aug 15, 2024
@codejedi365
Copy link
Contributor

No update yet, still in backlog.

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Aug 16, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 13, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 14, 2024
Copy link

It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?

@github-actions github-actions bot added the needs-update Needs status update from maintainers label Oct 15, 2024
@codejedi365
Copy link
Contributor

Another week or so and this will be part of the default template.

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Oct 16, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
Copy link
Contributor

🎉 This issue has been resolved in version 9.13.0 🎉

The release is available on:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants