search

mattbrictson / chandler

[unmaintained] chandler syncs your CHANGELOG entries to GitHub's release notes
MIT License
152 stars 15 forks source link

Submit link references with release notes #45

Closed deivid-rodriguez closed 5 years ago

deivid-rodriguez commented 5 years ago

Hello! Thanks for chandler, it's very useful!

We'll be using it to submit release notes to github. It works great except for a slight issue. We use link reference definitions for pull requests and users in our changelog in order to keep the raw version of it more readable. However, chandler does not submit them to GitHub, so github is unable to interpret them and show the proper links. The links still work because of the autolinking github feature, but they are displayed with ugly brackets around them. I think the issue would be fixed if the link reference definitions were submitted to github in addition to the content of each release, and that's what this PR implements.

deivid-rodriguez commented 5 years ago

Hei @mattbrictson, any thoughts about this? I've used it for a couple of releases so far and it works great! :)

deivid-rodriguez commented 5 years ago

Rebased to play nice with recent changes in master.

deivid-rodriguez commented 5 years ago

@mattbrictson Any thoughts about this? Even something like "I like the idea but I need to find some time to review it" or like "No way I'll add this to chandler" will help! Thanks!

mattbrictson commented 5 years ago

Actually, this is great 👍

So sorry I didn't review this when it first came around. I haven't worked on chandler it quite a while so I'm not prepared to do a deep dive into the implementation. However I see that your change is concise and has good test coverage, so this seems like an easy one to approve. Thanks for the contribution!

I will likely release a new version of Chandler this weekend that includes this.

mattbrictson commented 5 years ago

Note that the next chandler release will require Ruby 2.3+. Hope that's OK 😬

deivid-rodriguez commented 5 years ago

It is! Thanks so much @mattbrictson!

mattbrictson commented 5 years ago

🚀 0.9.0 released https://github.com/mattbrictson/chandler/releases/tag/v0.9.0