Description
While generating release notes for the v1.37.0-alpha.2 release, krel included kubernetes/kubernetes#137290 in the generated release notes even though the PR was intended to be excluded via release-note-none.
What happened
PR #137290 was included in the generated release notes .md file despite being marked as release-note-none.
After investigation, we found that the PR had a manually added release notes map file. It appears that if a release notes map file exists, krel includes the PR in the generated release notes regardless of the release-note-none marker.
Removing the map file causes the PR to be excluded in subsequent release note generation runs.
Expected behavior
If a PR is marked with release-note-none, it should not appear in the generated release notes, even if a release notes map file exists.
If the current behavior is intentional, it would be helpful to document this interaction clearly.
Additional context
While debugging, we also considered whether krel was matching release note content elsewhere in the PR body (for example, Go code blocks or other release-note-like text). However, the primary observation is that the presence of a release notes map file appears to override the release-note-none exclusion.
It would be helpful to clarify whether this precedence is intentional or whether release-note-none should always take priority.
Reproduction
- Create or use a PR marked with
release-note-none.
- Add a release notes map file for that PR.
- Run
krel release note generation.
- Observe that the PR is included in the generated release notes.
- Remove the map file and rerun the generation.
- Observe that the PR is no longer included.
References
Description
While generating release notes for the v1.37.0-alpha.2 release,
krelincluded kubernetes/kubernetes#137290 in the generated release notes even though the PR was intended to be excluded viarelease-note-none.What happened
PR #137290 was included in the generated release notes
.mdfile despite being marked asrelease-note-none.After investigation, we found that the PR had a manually added release notes map file. It appears that if a release notes map file exists,
krelincludes the PR in the generated release notes regardless of therelease-note-nonemarker.Removing the map file causes the PR to be excluded in subsequent release note generation runs.
Expected behavior
If a PR is marked with
release-note-none, it should not appear in the generated release notes, even if a release notes map file exists.If the current behavior is intentional, it would be helpful to document this interaction clearly.
Additional context
While debugging, we also considered whether
krelwas matching release note content elsewhere in the PR body (for example, Go code blocks or other release-note-like text). However, the primary observation is that the presence of a release notes map file appears to override therelease-note-noneexclusion.It would be helpful to clarify whether this precedence is intentional or whether
release-note-noneshould always take priority.Reproduction
release-note-none.krelrelease note generation.References