Skip to content

CORE-599: Generate release notes on release from PRs#4255

Merged
damemi merged 6 commits intoodigos-io:mainfrom
damemi:core-599-generate-release-notes
Mar 3, 2026
Merged

CORE-599: Generate release notes on release from PRs#4255
damemi merged 6 commits intoodigos-io:mainfrom
damemi:core-599-generate-release-notes

Conversation

@damemi
Copy link
Copy Markdown
Member

@damemi damemi commented Feb 16, 2026

What this PR does / why we need it:

From #4232 and https://github.com/odigos-io/odigos-enterprise/pull/2245, this updates the release job to generate the release notes and update the github release with those notes. Currently uses a fork of the k8s release-notes tool to include the change from kubernetes/release#4272

Changelog entry: Does this PR introduce a user-facing bug fix, feature, dependency update, or breaking change??

NONE

@damemi damemi force-pushed the core-599-generate-release-notes branch from b342ba6 to ef927fc Compare February 16, 2026 21:44
@damemi damemi force-pushed the core-599-generate-release-notes branch 2 times, most recently from 30a9ee1 to c216c8d Compare February 16, 2026 21:56
@damemi damemi force-pushed the core-599-generate-release-notes branch from c0d398b to d84b3ee Compare February 26, 2026 18:05
@damemi damemi marked this pull request as ready for review February 26, 2026 18:05

- name: Build release-notes tool
run: |
git clone --depth 1 --branch release-notes-custom-regex https://github.com/damemi/k8s-release.git /tmp/k8s-release
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can host this:
1/ just the bin at the repo
2/ at the ci core

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a ci-core action for this: odigos-io/ci-core#32

For now I'm fine checking out and building the fork of the generator tool. I'm hoping the k8s maintainers will merge my change and we can just drop that, don't think it's worth hosting the bin ourselves but added a note about that

@damemi damemi force-pushed the core-599-generate-release-notes branch 2 times, most recently from 35f9231 to 9693797 Compare February 27, 2026 19:20
Copy link
Copy Markdown
Contributor

@natyharary natyharary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small, small thing

@damemi damemi force-pushed the core-599-generate-release-notes branch from 9693797 to c894424 Compare March 2, 2026 13:51
@damemi
Copy link
Copy Markdown
Member Author

damemi commented Mar 2, 2026

@natyharary @aviadhahami updated, ptal
will depend on odigos-io/ci-core#32

@damemi damemi merged commit 23536e5 into odigos-io:main Mar 3, 2026
73 of 77 checks passed
damemi added a commit that referenced this pull request Mar 8, 2026
#### What this PR does / why we need it:
This adds a workflow to manually re-trigger the release note github
action. Tested locally with [act](https://github.com/nektos/act) on
v1.20.0-rc1 with dry-run: true:

```
$ act workflow_dispatch -W .github/workflows/update-release-notes.yml --input tag=v1.20.0-rc1 --input release_branch=releases/v1.20.0 --input dry_run=true -s GITHUB_TOKEN="$(gh auth token)" --env-file .env.act

...
[Update release notes/update-release-notes]   🐳  docker exec cmd=[bash --noprofile --norc -e -o pipefail /var/run/act/workflow/0-composite-5.sh] user= workdir=
| WARN No subcommand specified, running "generate"  
| INFO Using output format: markdown                
| INFO Gathering release notes                      
| INFO Starting to process commit 1 of 27 (3.70%): a32d547 
| INFO Starting to process commit 2 of 27 (7.41%): 828c9a2 
| INFO Starting to process commit 3 of 27 (11.11%): 88d2ae2 
| INFO Starting to process commit 4 of 27 (14.81%): 581585a 
| INFO Starting to process commit 5 of 27 (18.52%): f729e0d 
| INFO Starting to process commit 6 of 27 (22.22%): c599a76 
| INFO Starting to process commit 7 of 27 (25.93%): 23536e5 
| INFO Starting to process commit 8 of 27 (29.63%): 63f2145 
| INFO Starting to process commit 9 of 27 (33.33%): bd8dec4 
| INFO Starting to process commit 10 of 27 (37.04%): 78ff3cb 
| INFO PR #4345 contains exclusion (release-note-none) 
| INFO Starting to process commit 11 of 27 (40.74%): cffe6cd 
| INFO PR #4340 contains exclusion (release-note-none) 
| INFO Starting to process commit 12 of 27 (44.44%): 9d2670e 
| INFO PR #4328 contains exclusion (release-note-none) 
| INFO Starting to process commit 13 of 27 (48.15%): e4f67e2 
| INFO PR #4347 contains exclusion (release-note-none) 
| INFO Starting to process commit 14 of 27 (51.85%): 1f4f987 
| INFO PR #4350 does not seem to contain a valid release note, skipping 
| INFO Starting to process commit 15 of 27 (55.56%): a5872b8 
| INFO PR #4343 does not seem to contain a valid release note, skipping 
| INFO Starting to process commit 16 of 27 (59.26%): 1b5bf2d 
| INFO PR #4255 contains exclusion (release-note-none) 
| INFO Starting to process commit 17 of 27 (62.96%): 943d94d 
| INFO PR #4341 seems to contain a release note     
| INFO PR #4337 does not seem to contain a valid release note, skipping 
| INFO Starting to process commit 18 of 27 (66.67%): b6666cb 
| INFO Starting to process commit 19 of 27 (70.37%): d74cda9 
| INFO PR #4303 seems to contain a release note     
| INFO Starting to process commit 20 of 27 (74.07%): d2cf79c 
| INFO PR #4326 contains exclusion (release-note-none) 
| INFO PR #4327 seems to contain a release note     
| INFO Starting to process commit 21 of 27 (77.78%): aeab8a4 
| INFO Starting to process commit 22 of 27 (81.48%): fafa2d1 
| INFO PR #4321 seems to contain a release note     
| INFO Starting to process commit 23 of 27 (85.19%): dbc35d3 
| INFO PR #4315 seems to contain a release note     
| INFO Starting to process commit 24 of 27 (88.89%): d2130d3 
| INFO PR #4312 seems to contain a release note     
| INFO Starting to process commit 25 of 27 (92.59%): 5777a00 
| INFO PR #4330 seems to contain a release note     
| INFO Starting to process commit 26 of 27 (96.30%): aaf032f 
| INFO PR #4322 seems to contain a release note     
| INFO Starting to process commit 27 of 27 (100.00%): eb41531 
| INFO PR #4335 contains exclusion (release-note-none) 
| INFO PR #4336 contains exclusion (release-note-none) 
| INFO PR #4319 contains exclusion (release-note-none) 
| INFO PR #4313 contains exclusion (release-note-none) 
| INFO PR #4314 contains exclusion (release-note-none) 
| INFO PR #4279 contains exclusion (release-note-none) 
| INFO PR #4311 contains exclusion (release-note-none) 
| INFO PR #4306 contains exclusion (release-note-none) 
| INFO PR #4304 seems to contain a release note     
| INFO PR #4302 seems to contain a release note     
| INFO Checking PRs for mapped data                 
| INFO Finished gathering release notes in 2.368965126s 
| INFO Got 10 release notes, performing rendering   
| INFO Release notes written to file: release-notes.md 
[Update release notes/update-release-notes]   ✅  Success - Main Generate release notes [2.626404708s]
[Update release notes/update-release-notes] ⭐ Run Main Print release notes
[Update release notes/update-release-notes]   🐳  docker exec cmd=[bash --noprofile --norc -e -o pipefail /var/run/act/workflow/0-composite-6.sh] user= workdir=
| ## Generated release notes
| ```
| ## Changes by Kind
| 
| ### Uncategorized
| 
| - Add "Recover" action in the source drawer for workloads whose instrumentation was rolled back due to a crash (#4302, @alonkeyval)
| - Ci: update ci-core/vuln-scan (#4327, @aviadhahami)
| - Feat: integrate ELK layout for service-map (#4341, @BenElferink)
| - Fix: helm reject any affinity rules due to a wrong schema validation `additionalProperties` field (#4304, @tamirdavid1)
| - Fix: include source workloads from specified namespaces in DiagnoseGraphQL (#4312, @BenElferink)
| - Fix: make 'fromSources' field required for k8s attributes action (#4322, @BenElferink)
| - Gateway metrics to be send to the metricStore (VictoriaMetrics) (#4315, @tamirdavid1)
| - Perf: source modal now loads all namespaces and workloads in a single cached query, replacing slow per-namespace K8s API calls (#4303, @alonkeyval)
| - Properly handle exec and fork events performed by not the main thread (#4321, @tamirdavid1)
| - Properly handle exec and fork events performed post odiglet restarts (#4330, @tamirdavid1)
...
```

#### Changelog entry: Does this PR introduce a user-facing bug fix,
feature, dependency update, or breaking change??
<!--
This section will go in the release notes for this version. Is this
something users should be able to find easily?
If no, just write "NONE" in the release-note block below.
If yes, please add a release note in the block below describing this in
1-2 sentences for our changelog.
-->

```release-note
NONE
```
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

Successfully merging this pull request may close these issues.

3 participants