🚀 Use Milestone and Contributor information for Release Notes

Is there an existing issue for this?

• I have searched the existing issues

Suggestion

ElectionGuard python uses GitHub milestones to keep track of all the issues. It would be very helpful to use these milestones to create the issues since closing milestones starts the release build.

The idea is to use the title and description on the milestone to create the release description.

As a fun addition, if we could display the contributors profile icons and links to their profiles on the release that would be an awesome way to showcase the communities contributions.

Possible Implementation

Here is an example of what the ideal release notes would look like:

# Milestone Name
Insert milestone description

## Issues
[All included issues](link_to_milestone)

## Contributors
Display all contributors profile pictures and links to profiles

Anything else?

No response

[keithrfung]

Yes, of course.

This is the workflow you want to look at. https://github.com/microsoft/electionguard-python/blob/82df51b72514bc63d1237f692d46d8381c604fd1/.github/workflows/release.yml#L87-L152

The simplest path is probably to make a python repository yourself and test out a couple GitHub workflows to figure out how this would work. Then transfer this knowledge into adapting this workflow, since this workflow only runs on completed milestones for us.

My thoughts would be to dynamically create the markdown document. I would likely make a command called make release-notes in the MakeFile. Then add items like:

touch release_notes.md
echo '# Title` >> release_notes.md

We use https://github.com/actions/create-release to create the release. This file could probably be attached there.

[wanjuntham]

@keithrfung I have created PR #485 , could you please help to review it?