question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Clickable issue links in CHANGELOG.md

See original GitHub issue

Affected Packages

Not sure, the one which generates actual changelog from changeset files

Problem

We have this pattern that issue numbers in the GitHub form of #1234 are added to changes entries. This works well in the bot’s release pull requests since they become clickable

However, in the final CHANGELOG.md they are plain text #1234.

Proposed solution

It would be nice to have an (opt-in?) feature to also render them as actual GitHub links in the final markdown

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:8 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
tpluscodecommented, Mar 15, 2021

Ironically, I don’t necessarily want these particular bits of information. Especially the “thank you” note does not make much sense in the project at hand, given that we’re pretty much working as a closed team. Open source indeed, but not really expecting outside collaborators at this time any way

What I would prefer is an agnostic feature to do the replacement in the output markdown… 🤔

0reactions
abdonrdcommented, Jul 20, 2021

Also interested in something like @changesets/changelog-github (with links to commits and PRs) but without the thank-yous.

Read more comments on GitHub >

github_iconTop Results From Across the Web

how to get links to versions in CHANGELOG.md file #71 - GitHub
Hi guys, I'm using same style as here https://github.com/olivierlacan/keep-a-changelog/blob/gh-pages/CHANGELOG.md for my change log file ...
Read more >
Add http link to changelog to help page - GitLab.org
Link issues together to show that they're related or that one is blocking others. Learn more. Activity. Sort ...
Read more >
How to use links in documentation - Contributor guide
Bookmark links​​ Click the link icon and then copy the bookmark anchor text from the URL (that is, the part after the hash)....
Read more >
How do I prevent auto-generated links in the GitHub wiki?
This issue should be allievated with issue 136198 "markdown preview ... false will disable linkify features entirely, setting md.linkify.
Read more >
Link to Pages - ReadMe Documentation
If you link across multiple projects, you must use standard Markdown hyperlinks. Anchor Links. All section headers include an anchor link. The format...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found