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

update release note generation #3591

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

radTuti
Copy link
Contributor

@radTuti radTuti commented Nov 6, 2024

Description

  • ensure milestone is closed before generating release notes
  • ensure there are no open PRs in the milestone

For PR author

  • Tests for change.
  • If changing pkg/apis/, run make gen-files
  • If changing versions, run make gen-versions

For PR reviewers

A note for code reviewers - all pull requests must have the following:

  • Milestone set according to targeted release.
  • Appropriate labels:
    • kind/bug if this is a bugfix.
    • kind/enhancement if this is a a new feature.
    • enterprise if this PR applies to Calico Enterprise only.

)
# Since we only want merged PRs, raise an error if there are none.
if len(merged_issues) == 0:
raise ReleaseNoteError(f"no issues found for milestone {m.title}")
Copy link
Contributor

Choose a reason for hiding this comment

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

Technically we have had operator releases in the past which have no release-note-required PRs, so technically having no merged issues isn't necessarily an error - but we should probably call it out to the user to ensure they can double-check the results and/or add a disclaimer for users.

This was the case for v1.34.5, as an example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In that case, we should not be using this tooling to generate release notes.

Copy link
Contributor

Choose a reason for hiding this comment

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

It still generates the outline for the release notes, so it's still valuable to run.

@radTuti radTuti requested a review from danudey November 6, 2024 18:24
- ensure milestone is closed before generating release notes
- ensure there are no open PRs in the milestone
@radTuti radTuti force-pushed the gen-release-notes branch 5 times, most recently from 56ef75b to 851be6e Compare November 19, 2024 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants