Skip to content
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

Automate releasenote #143

Open
Sander3003 opened this issue Nov 3, 2021 · 3 comments
Open

Automate releasenote #143

Sander3003 opened this issue Nov 3, 2021 · 3 comments

Comments

@Sander3003
Copy link
Member

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

dlabordus commented Jan 13, 2022

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

  • Create a branch "releases/<version>" and checkout this branch.
  • Create a label "<version>".
  • Create the release notes with one of the existing actions.
  • Append the release notes to the existing "CHANGELOG.md"
  • Commit the file and update the label to point to the new commit
  • Create 1 (or 2) pull request(s) to "main" (and "develop") to merge the changes to these branches.

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

Flurb commented Jun 30, 2022

@dlabordus @Sander3003 release notes are created automatically right?

@Sander3003
Copy link
Member Author

I leave to judgement up to @dlabordus

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

No branches or pull requests

3 participants