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

chore: rework release note handling #1139

Conversation

jakobmoellerdev
Copy link
Contributor

What this PR does / why we need it

reworks release note management based on github release note api

It does this in the following way:

  1. Creates a tag on cutoff that is annotated
  2. Calls the Github Release Note API together with a release note configuration file (very similar to drafter but allows us to specify a previous tag)
  3. Generates the notes for the current branch based on the last found tag.

This has the advantage that we can explicitly determine which release notes are generated from when to when and also use the contributors fields.

TODO:

  1. Test on other repo
  2. Make sure that the Merge commit in main that we used for testing disappears.

Which issue(s) this PR fixes

@github-actions github-actions bot added chore component/github-actions Changes on GitHub Actions or within `.github/` directory size/m Medium labels Nov 25, 2024
hilmarf
hilmarf previously approved these changes Nov 26, 2024
@hilmarf hilmarf added this to the 2024-Q4 milestone Nov 26, 2024
@jakobmoellerdev jakobmoellerdev dismissed hilmarf’s stale review November 26, 2024 08:55

The merge-base changed after approval.

@jakobmoellerdev jakobmoellerdev force-pushed the chore/rework-release-note-handling branch 2 times, most recently from 20ac0d0 to 9863ce7 Compare November 26, 2024 09:03
hilmarf
hilmarf previously approved these changes Nov 26, 2024
@jakobmoellerdev jakobmoellerdev marked this pull request as ready for review November 26, 2024 11:35
@jakobmoellerdev jakobmoellerdev requested a review from a team as a code owner November 26, 2024 11:35
@jakobmoellerdev jakobmoellerdev force-pushed the chore/rework-release-note-handling branch from 9c2ea53 to 059e375 Compare November 26, 2024 12:15
.github/workflows/release-drafter.yaml Outdated Show resolved Hide resolved
.github/workflows/release-drafter.yaml Outdated Show resolved Hide resolved
.github/workflows/release.yaml Outdated Show resolved Hide resolved
hilmarf
hilmarf previously approved these changes Nov 26, 2024
reworks release note management based on github release note api

It does this in the following way:
1. Creates a tag on cutoff that is annotated
2. Calls the Github Release Note API together with a release note configuration file (very similar to drafter but allows us to specify a previous tag)
3. Generates the notes for the current branch based on the last found tag.
@jakobmoellerdev jakobmoellerdev merged commit 7b3927d into open-component-model:main Nov 26, 2024
19 checks passed
@hilmarf hilmarf added the kind/chore chore, maintenance, etc. label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/github-actions Changes on GitHub Actions or within `.github/` directory kind/chore chore, maintenance, etc. size/m Medium
Projects
Status: 🔒Closed
Development

Successfully merging this pull request may close these issues.

3 participants