Skip to content

Add links to github/gitlab issues in changelog #194

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
nicholasamorim opened this issue Mar 18, 2020 · 10 comments
Closed

Add links to github/gitlab issues in changelog #194

nicholasamorim opened this issue Mar 18, 2020 · 10 comments
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request

Comments

@nicholasamorim
Copy link

commitizen allows you to specify a ticket number at the end of the process. This information is stripped from the changelog output.

How can I add it?

@relekang
Copy link
Member

Do you have an example commit?

@nicholasamorim
Copy link
Author

    build(automation,nginx,errbot): errbot conf now uses Ceph mountpoint. Added nginx errbot files

    MapR broke errbot because the configuration was stored on it. This commit changes the location of
    the data. In the past, I forgot to add errbot's nginx files - necessary for authentication.

    fix #5238

@relekang relekang added feature A new feature or a feature request help-wanted Extra attention is required labels Mar 19, 2020
@relekang relekang changed the title Important information does not show on the changelog. Add links to github/gitlab issues in changelog Mar 19, 2020
@danth danth added this to the Better Changelogs milestone Apr 27, 2020
@achary
Copy link

achary commented Dec 14, 2021

I would say, supporting arbitrary pattern as a issue link would be very useful here, so not only hard-coding to Gitlab/Github issues.

For example, some organisations use exteral issue tracking systems. Linking to those would make a lot of sens and help in adoption.

Proposal

The arbitrary, user-defined URL scheme could be given as a config key, perhaps templated with {issue_number} placeholder like this:

// in pyproject.toml
external_issue_url = "http://some.url.com/browse/{issuse_number}"

The following example commit, could then be supported:

    fix: No more process hang on bad inputs.

    Input data is validated before being passed down to executor. This also addresses input validation request.

    Fixes #FOO-123, #FOO-456

ideally producing hyperlinks to these issues respectively in the changelog:

...
* No more process hang on bad inputs [FOO-123](http://some.url.com/browse/FOO-123), [FOO-123](http://some.url.com/browse/FOO-123)
...

It would make sense, for the tool to use build-in defaults URL scheme for GitHub and GitLab issues, but when IT IS set, then a custom URL pattern should kick in.

@github-actions github-actions bot removed the help-wanted Extra attention is required label Dec 15, 2021
@github-actions github-actions bot added the help-wanted Extra attention is required label Jan 5, 2022
@github-actions github-actions bot removed the help-wanted Extra attention is required label Oct 23, 2022
@github-actions github-actions bot added the stale label May 6, 2024
@codejedi365 codejedi365 added help-wanted Extra attention is required confirmed Prevent from becoming stale and removed stale labels May 6, 2024
@codejedi365 codejedi365 removed the help-wanted Extra attention is required label May 13, 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 Jul 13, 2024
@codejedi365
Copy link
Contributor

A redesign is in progress to hopefully address this sooner than later. Likely a few more months though.

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Jul 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 Sep 12, 2024
@codejedi365
Copy link
Contributor

Still in the backlog.

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Sep 16, 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 Nov 15, 2024
@codejedi365
Copy link
Contributor

Should be completed in the next few weeks.

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Nov 16, 2024
@codejedi365
Copy link
Contributor

🎉 This issue has been resolved in version 9.15.0 🎉

The release is available on:


Since this issue has been open for so long, there have been some significant changes in PSR since. I do believe this is as close as we can get it to resolution of the original request. v9.15.0 provides a parsing mechanism to extract the issue numbers into the resulting ParsedCommit objects. Then with custom changelogs you are able to use the ParsedCommit object's linked_issues attribute to extract link references. From there, you can pass those values to the VCS's issue_url filter to generate the URL for whichever format you desire. I have included an example of this on the Changelog Templates page under the issue_url filter details. I have not added any formatting to the default changelog to identify closed issues though so right now it is only available to people whom write their own custom changelogs.

There is a future endeavor to post updates to issues and prs #975 which I think will hammer out any details related to separate issue tracking systems outside of the configured remote VCS.

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

No branches or pull requests

5 participants