-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automatically crediting the author/contributor of the PR in the release notes #89
Comments
@ghuntley yes, I like this idea. If you have a look at this blog post: http://cakebuild.net/blog/2016/09/cake-v0-16-0-released I have some working code to generate the list of contributors that you can see there. Adding that to an item in the release notes is "harder". An issue might have been created by one person, and fixed by another via a pull request. Stitching the two together is where it becomes hard. Not impossible, just not sure how much effort it will take. The list of contributors is very simple to generate. |
List of contributors, with a hyperlink to commits by author would suffice imho. |
@ghuntley yes, that sounds doable 😄 |
Some other ideas which are kinda glamourous :) https://twitter.com/RobertWPearce/status/910978463586074625 Why have a hyperlink when you can put someone's avatar in the release notes? |
Two things to keep in mind:
In my opinion, the ultimate solution for this feature would be something like this:
I'm currently working on a proof of concept. If I'm successful I'll be happy to contribute a PR to implement this new feature. |
This would be a great addition! |
Determining if an issue is linked to a PR (and vice-versa) is turning out to be much more difficult than I anticipated because the Github API does not return this info when an issue is retrieved. I did a lot of research and I found people offering two possible solutions:
The first option would be my preferred solution but, as I explained in this comment, I hit a dead end. The second option (presented here) is very brittle since it relies on the presence of a HTML node with a specific CSS class. This can change at any moment if Github decides to make changes to their UI. |
Maybe there's a third possible solution: use a GraphQL query to retrieve the desired data. I haven't explored Github GraphQL API, so this will be a learning experience for me. I'll spend some time researching/learning and report my findings. |
Let's discuss a potential feature/addition to GitReleaseManager!
Why? People like seeing their name up in lights, it a small gesture and a great way to encourage contributions. This functionality exists in GitReleaseNotes.
The text was updated successfully, but these errors were encountered: