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

Simplify management of Release Notes #1097

Closed
jakobmoellerdev opened this issue Nov 18, 2024 · 3 comments
Closed

Simplify management of Release Notes #1097

jakobmoellerdev opened this issue Nov 18, 2024 · 3 comments
Assignees
Labels
area/ipcei Important Project of Common European Interest kind/feature new feature, enhancement, improvement, extension

Comments

@jakobmoellerdev
Copy link
Contributor

jakobmoellerdev commented Nov 18, 2024

What would you like to be added:

  • Change all Release Note actions towards generating the Release Notes once and then appending new changes as they come in if possible
  • If this is not possible, we should change the Release Notes to be only manually touched up once before the release and take over the release notes from previous candidates where applicable
  • Once this is done, we can also get rid of the release notes in the branches themselves because the github release notes can be trusted.

Why is this needed:

Currently the github action for the release drafter (https://github.com/open-component-model/ocm/blob/main/.github/workflows/release-drafter.yaml) is only able to work with the ref that is pointed towards it (i.e. main or the release branch)

This leads to the fact that the automation will overwrite any manual changes made to the release notes. This is impractical since that means that for every release candidate we will have to copy over changes made manually, or create a PR for the release notes.

release-drafter/release-drafter#656

@jakobmoellerdev jakobmoellerdev added the kind/feature new feature, enhancement, improvement, extension label Nov 18, 2024
@jakobmoellerdev jakobmoellerdev self-assigned this Nov 18, 2024
@github-actions github-actions bot added the area/ipcei Important Project of Common European Interest label Nov 18, 2024
jakobmoellerdev added a commit that referenced this issue Nov 18, 2024
<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

This sets up a github workflow that triggers the integration test via
workflow call. This allows us to directly have them in our job overview,
allowing us to remove the event based trigger with comments.

An example run can be seen here:
https://github.com/open-component-model/ocm-cicd-playground/actions/runs/11855343659/job/33039365025

The corresponding adjustment PR in the integration test repo can be
found here:
open-component-model/ocm-integrationtest#31

#### Which issue(s) this PR fixes
<!--
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->
fix #1097
@github-project-automation github-project-automation bot moved this from 🆕 ToDo to 🍺 Done in OCM Backlog Board Nov 18, 2024
@frewilhelm
Copy link
Contributor

Did you close this issue with the correct PR? This should be #1098 right?

@github-project-automation github-project-automation bot moved this from 🍺 Done to 📋 Next-UP in OCM Backlog Board Nov 19, 2024
@jakobmoellerdev
Copy link
Contributor Author

Thanks, no that was by accident

hilmarf added a commit that referenced this issue Nov 22, 2024
#### What this PR does / why we need it

It's one step to "Simplify management of Release Notes" -
#1097
@jakobmoellerdev
Copy link
Contributor Author

The release notes are now no longer stored in the repo thanks to @hilmarf and we currently generate a draft on every commit to the release branch that is based on the last tag found (for z==0 this is the minor patch notes, for every z>0 it is the patch notes for the next z version). This means that the release notes are automatically updated. Together with the fact that we now have properly labelled and controlled pull requests, we now ensure compliant categories and no longer need to manually append things most of the time. That means that we now dont need to have manual edits anymore in 99% of cases so i consider this done.

@github-project-automation github-project-automation bot moved this from 📋 Next-UP to 🍺 Done in OCM Backlog Board Nov 27, 2024
@ocmbot ocmbot bot moved this from 🍺 Done to 🔒Closed in OCM Backlog Board Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ipcei Important Project of Common European Interest kind/feature new feature, enhancement, improvement, extension
Projects
Status: 🔒Closed
Development

No branches or pull requests

2 participants