com-pas / compas-architecture

Project's architecture documentation
Creative Commons Attribution 4.0 International
9 stars 5 forks source link

Automate releasenote #143

Open Sander3003 opened 2 years ago

Sander3003 commented 2 years ago

I an software engineer I would like to automat the releasenotes So I don't need to write all release notes by hand

Example: https://github.com/release-drafter/release-drafter

dlabordus commented 2 years ago

First step are made to start using the feature of GitHub to automatically create the release notes when a release is created. The release notes are created by retrieving all the pull request merged since the last release and use that description and labels to create the release notes. (https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) But this means creating the release is still a manual step. And also updating files isn't possible. Doing more automatically will cause more time, because we need to figure out how the flow needs to be setup. A idea is:

Create a workflow that will be executed manually when a release needs to be made. Ask the version number that needs to be created when starting the workflow. Next automate the following steps in the workflow

We only need to figure out what to do with the existing "release_project.yml" workflow that actually builds the project and publish them. We can include them, but that will become quit a large workflow, or call it.

Flurb commented 2 years ago

@dlabordus @Sander3003 release notes are created automatically right?

Sander3003 commented 2 years ago

I leave to judgement up to @dlabordus