CHANGELOG: and links to references

tarkah / tickrs

Realtime ticker data in your terminal 📈

MIT License

1.16k stars 58 forks source link

CHANGELOG: and links to references #56

Closed miraclx closed 3 years ago

miraclx commented 3 years ago

GitHub doesn't auto-link references to issues/PRs in files other than README.md

https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls#issues-and-pull-requests Screenshot_20210208_231343

tarkah commented 3 years ago

Ahh, nice catch. Thanks!

miraclx commented 3 years ago

This seems to have unintended side effects in the new release doc

Now

Screenshot_20210209_002415

Before

Screenshot_20210209_002743

It seems, in release docs, auto-linking refs work just fine, but not in the CHANGELOG.md file directly.

You could just edit the release doc but there's gotta be a better way to retain references when viewing the CHANGELOG.md directly vs when you look at the release page

tarkah commented 3 years ago

Yeah, I'll try to be better about removing the brackets when copying / pasting into the release. Worst case, the links still work so I'm not too concerned.

miraclx commented 3 years ago

Oh, I assumed it was autogenerated by github-actions. It still would require some extra effort on your part, so it's best to iron that out.

I used reference-style links to make it easier to read without md rendering.

You can try using the full-format to see if that renders correctly

- [#54]
+ [#54][#54]

Or just using the full thing

- [#54]
+ [#54](https://github.com/tarkah/tickrs/pull/54)
...
...
- [#54]: https://github.com/tarkah/tickrs/pull/54