chore: add RELEASE.md to document release process - #2828
Conversation
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
|
Canceling the GHA's to same some electricity ⚡ |
📝 WalkthroughWalkthroughAdded Merge Risk: 🟡 Moderate · up to This PR adds release instructions, but the documented Helm chart destinations do not match the publication workflow, which could lead to an incorrect release. Update the destinations before merging; the branch-placeholder issue is a smaller follow-up. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
RELEASE.md (1)
16-16: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse an explicit branch placeholder
No in-repository workflow or script renders
RELEASE.md. If no external process renders it, readers can copybump-release-{{ .VERSION }}literally. Replace both occurrences withbump-release-<VERSION>or document the rendering step.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: QUIET
Plan: Enterprise
Run ID: 22853f2e-834a-42d4-8707-c50618213bca
📒 Files selected for processing (1)
RELEASE.md
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.
| The container and helm chart are published to nvcr.io. | ||
| The OLM bundle is published to the [Red Hat certified operators production catalog](https://github.com/redhat-openshift-ecosystem/certified-operators). |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Correct the Helm chart publication destinations.
The supplied workflow publishes the chart to oci://ghcr.io/${repository_owner}/gpu-operator/charts, but this document lists nvcr.io and gh-pages. Update the artifact description and checklist to match the workflow. Keep nvcr.io or gh-pages only if separate publication steps exist and are documented.
Also applies to: 22-23
1 participant
Description
This addresses SIG-REL-01 and SIG-REL-08 from the OSS Scorecard. This takes inspiration from https://github.com/NVIDIA/nvidia-container-toolkit/blob/main/RELEASE.md.
Note, there are some steps, like creation of a version bump PR, creation of a release issue, etc. which the toolkit repo has some scripts for. We could develop similar scripts / GHA workflows in the future for this project as well and evolve the RELEASE.md accordingly.
Checklist
make lint)make validate-generated-assets)make validate-modules)Testing
OSS scorecard was run with and without this change.