Skip to content

Docs: Adds Release Workflow Doc #11542

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

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

Conversation

danehans
Copy link
Contributor

Description

Adds a document that guides a maintainer through the process of cutting a Kgateway release.

Change Type

/kind documentation

Changelog

Adds release workflow document.

Additional Notes

Fixes #11447

Copy link
Member

@timflannagan timflannagan left a comment

Choose a reason for hiding this comment

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

Quick passthrough. Just a couple of inline comments but general structure LGTM. cc @lgadban

- The release notes must be manually added to contain the bug fixes, features, etc. included in the release.
- This part of the process will be improved once [Issue 11436](https://github.com/kgateway-dev/kgateway/issues/11436) is fixed.

## Verification
Copy link
Member

Choose a reason for hiding this comment

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

The release workflow dispatch also supports a "validate release" artifacts option, which bootstraps an environment from those artifacts & runs basic validation checks by running those conformance suite against that deployed environment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@timflannagan thanks for these details. I was unsure what the "validate release" option provides. I'll update the guide to include this step.

@timflannagan
Copy link
Member

@danehans broken markdown refs for the downstream section but otherwise lgtm

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.

Docs: Create Release Workflow Doc
2 participants