Skip to content

[Meta] Don't format issue numbers as code in action-gh-release's own release notes #778

@Marcono1234

Description

@Marcono1234

Within action-gh-release's own release notes at https://github.com/softprops/action-gh-release/releases, is there a reason why you are formatting the fixed issue numbers as code?
For example:

It fixes #639, #571, ...

This makes it a bit cumbersome to read the release notes because it is not clear what the issue numbers refer to; you have to manually create the URL and open it in a new tab.
If you instead used GitHub's auto-referencing of #... issue numbers, or full https://github.com/softprops/action-gh-release/issues/<number> links, then the UI would add a link and even show a hover preview. That would make it easier for users to read.

Or maybe it would be useful if those issues were also / instead linked in the "What's Changed" sections?

I am not asking for rewriting all previous release notes, but unless there is some technical limitation, would it be possible to use issue links for future release notes?

Also, thanks for maintaining this action in the first place!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions