Improve release notes [4h]

[AronNovak]

Desired format

Release 1.11

• Issue one (#11111)
  • Pull request one (#22222)
  • Pull request two (#444444)
• Issue Two (#999999)
  • Pull request (#1234567)

Contributors:

• User1
• User2
• User3

(authors of the issues and the pull requests enumerated above)

Technical notes

It will mean that the release notes script will require a personal access token to GitHub to gather all this information. I can save it locally to avoid to enter it again and again

[AronNovak]

^^ @isapisa any requests for the output?

[isapisa]

@AronNovak I wonder if the above format is necessary due to the current output of referenced issues and pull request that github already do out of the box now. Otherwise, I like it

[AronNovak]

github already do out of the box now

Hm, maybe I am not aware of something, let me check.

[AronNovak]

@isapisa The current release notes at client projects are not from GitHub, but generated by a Robo script that we developed. The idea is to improve it to have the issue titles too and group the pull requests by issues.

[isapisa]

this is what I mean:

https://github.com/Gizra/undg-country/issues/3447#issuecomment-866096836

[AronNovak]

@isapisa Are you sure that it's not crafted by Mariano by hand?

[isapisa]

@AronNovak no, this was out of the box. Maybe github tested this for some users and it looks like now it's no longer a feature anymore.

[AronNovak]

Yep. But the release notes for that version looks different: https://github.com/Gizra/undg-country/releases/tag/1.22.1 So it's still a bit strange, anyways, I go ahead to improve what we have.

[isapisa]

@AronNovak yep, just FYI, this is what we had to do because of that feature: https://github.com/Gizra/unsdg/releases/tag/2.4.0

But maybe everyone got annoyed at it and they rolled it back :D