Skip to content

Auto-linked references to commits/PRs in changelog #1109

Open
@paduszyk

Description

@paduszyk

Description

We all use GitHub's auto-links to refer to commits and pull requests.

I think it would be nice if the changelogs generated by the tool had them as well.

Commits added by push and squash merge could have SHA1 and PR references, respectively, appended, e.g.:

  • fix: resolve an urgent issue [abcd123]
  • feat: add a new feature (#1)

Possible Solution

I believe this proposal would require:

  • update the default templates (SHA1 is already found in the context);
  • update commit parser to detect that the commit message includes r"#\d+"

Additional context

This would also require adding (somewhere in the settings) extra info on the base URL for the repo.

If they are not found, the auto-link generation may be disabled by default.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions