Skip to content
This repository has been archived by the owner on May 16, 2021. It is now read-only.

Submit link references with release notes #45

Merged

Conversation

deivid-rodriguez
Copy link
Contributor

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
Copy link
Contributor Author

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

@deivid-rodriguez deivid-rodriguez force-pushed the submit_link_references branch 2 times, most recently from d768134 to c46770b Compare January 17, 2019 15:53
@deivid-rodriguez
Copy link
Contributor Author

Rebased to play nice with recent changes in master.

[@Wowu]: https://github.com/Wowu
[@wspurgin]: https://github.com/wspurgin
[@zorab47]: https://github.com/zorab47
[@chrp]: https://github.com/chrp
Copy link
Contributor Author

@deivid-rodriguez deivid-rodriguez Jan 18, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a real changelog, that's why it's quite big. But if you want a more minimal file, I can reduce it.

@deivid-rodriguez
Copy link
Contributor Author

@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
Copy link
Owner

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 mattbrictson merged commit 8f74b0b into mattbrictson:master Feb 7, 2019
@mattbrictson
Copy link
Owner

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

@deivid-rodriguez
Copy link
Contributor Author

It is! Thanks so much @mattbrictson!

@deivid-rodriguez deivid-rodriguez deleted the submit_link_references branch February 8, 2019 09:14
@mattbrictson
Copy link
Owner

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants