Skip to content

Changelog does not link to issues and authors #22

Description

@clue

The changelog for each component does not currently link to issues (#NUMBER) or author names (@NAME). Compare for example https://reactphp.org/stream/changelog.html with https://github.com/reactphp/stream/releases.

I think it makes sense to implement this feature so that links are added automatically for consistency reasons. This only applies to the changelog and not the other markdown files, so I suppose it's relatively safe to apply some simple regular expressions here.

Any input is welcome 👍

Activity

  1. jsor commented on Nov 8, 2017

    @jsor
    Member

    That's just because we're rendering the changelog like all other markdown files, so the comparision should be https://reactphp.org/stream/changelog.html with https://github.com/reactphp/stream/blob/master/CHANGELOG.md.

    Another option would be to read the releases from the GH api, parse the body in gfm mode and build the list ourself.

  2. clue commented on Nov 8, 2017

    @clue
    MemberAuthor

    @jsor I understand why this is currently not linked and agree that comparing this to the raw CHANGELOG.md does indeed make sense.

    As an alternative, we could also ensure that each of our CHANGELOG.md files contains full links instead of relying on auto-linking. I recall doing this for some of my projects a while back, but figured it's not really worth the effort as it does cause some overhead for each and every release. What do you suggest?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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