-
Notifications
You must be signed in to change notification settings - Fork 17
chore: Added release branch support to CI workflows #67
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
base: main
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds support for release branches (e.g., release-1.11) across the CI/CD infrastructure, aligning with Kubeflow Pipelines' branching conventions. The changes enable CI workflows to run on both the main branch and release branches, and update documentation to guide contributors on the branching strategy.
Changes:
- Added comprehensive branching strategy documentation to CONTRIBUTING.md with examples
- Updated all 9 GitHub workflow files to trigger on both
mainandrelease-*branches - Changed detect.py script default reference from
origin/maintoorigin/HEADfor generic local usage
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/CONTRIBUTING.md | Adds new "Branching Strategy" section documenting release branch naming, purpose, and base image tag conventions |
| .github/workflows/yaml-lint.yml | Adds release-* to pull_request branches and normalizes quoting to single quotes |
| .github/workflows/validate-metadata-schema.yml | Adds release-* branch trigger for pull_request events |
| .github/workflows/scripts-tests.yml | Adds release-* branch triggers for both push and pull_request events with single quote normalization |
| .github/workflows/readme-check.yml | Adds release-* branch trigger for pull_request events |
| .github/workflows/python-lint.yml | Adds release-* to pull_request branches and normalizes quoting to single quotes |
| .github/workflows/markdown-lint.yml | Adds release-* to pull_request branches and normalizes quoting to single quotes |
| .github/workflows/component-pipeline-tests.yml | Adds release-* branch triggers for both push and pull_request events (uses double quotes) |
| .github/workflows/build-packages.yml | Adds release-* branch triggers for both push and pull_request events with single quote normalization |
| .github/workflows/base-image-check.yml | Adds release-* branch triggers for both push and pull_request events with single quote normalization |
| .github/scripts/detect_changed_assets/detect.py | Changes default base-ref from origin/main to origin/HEAD for generic local usage |
| .github/scripts/detect_changed_assets/README.md | Updates documentation to reflect origin/HEAD as the default base reference |
| .github/actions/detect-changed-assets/README.md | Updates input documentation table to clarify dynamic default for base-ref in PR context |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Helber Belmiro <[email protected]>
1120505 to
a79c2df
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| python3 .github/scripts/detect_changed_assets/detect.py --base-ref origin/HEAD --head-ref HEAD | ||
| # With pattern filter | ||
| python3 .github/scripts/detect_changed_assets/detect.py --base-ref origin/main --filter '\.py$' | ||
| python3 .github/scripts/detect_changed_assets/detect.py --base-ref origin/HEAD --filter '\.py$' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we be using uv here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should. Fixed.
docs/CONTRIBUTING.md
Outdated
| | Branch | Purpose | Base Image Tag | | ||
| |---------------------------|--------------------------------------------|-----------------------| | ||
| | `main` | Active development | `:main` | | ||
| | `release-<major>.<minor>` | Release maintenance (e.g., `release-1.11`) | `:v<major>.<minor>.0` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's be explicit that z-stream releases could be possible (not always x.y.0)
| | Branch | Purpose | Base Image Tag | | |
| |---------------------------|--------------------------------------------|-----------------------| | |
| | `main` | Active development | `:main` | | |
| | `release-<major>.<minor>` | Release maintenance (e.g., `release-1.11`) | `:v<major>.<minor>.0` | | |
| | Branch | Purpose | Base Image Tag | | |
| |---------------------------|--------------------------------------------|---------------------------------| | |
| | `main` | Active development | `:main` | | |
| | `release-<major>.<minor>` | Release maintenance (e.g., `release-1.11`) | `:v<major>.<minor>.<z-stream>` | |
Also, it may be outside the scope of this PR but if not perhaps adding a quick section about z-stream releases here, their contents, and what triggers them may be useful
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
…nstead of `python3` in scripts and documentation Signed-off-by: Helber Belmiro <[email protected]>
…e guidelines in CONTRIBUTING.md Signed-off-by: Helber Belmiro <[email protected]>
Signed-off-by: Helber Belmiro <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Helber Belmiro <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
gmfrasca
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Description of your changes:
Added support for
release-<major>.<minor>branches (e.g.,release-1.11) across all CI workflows, following the Kubeflow Pipelines branching convention.Changes
CONTRIBUTING.mdrelease-*to branch triggers in all 9 workflow filesdetect.pydefault fromorigin/maintoorigin/HEADfor generic local usageBranch Convention
main:mainrelease-1.11:v1.11.0Checklist:
Pre-Submission Checklist
Learn more about the pull request title convention used in this repository.
Additional Checklist Items for New or Updated Components/Pipelines
metadata.yamlincludes freshlastVerifiedtimestampare present and complete
snake_casenaming convention