feat(ci): Add automated release CI job #65

kramaranya · 2025-08-21T19:46:42Z

I added a CI job for release process automation:

The Prepare Release GitHub Action automatically:

Detects the version change in kubeflow/__init__.py
Creates or updates the release-X.Y branch
Cherry-picks the version bump commit from main

The Release GitHub Action automatically:

Runs tests and builds the package
Creates and pushes the release tag
Publishes to PyPI (requires manual approval)
Creates GitHub Release (requires manual approval)

I also added the script to generate CHANGELOG and update the version.
And added Release README

I've tested this workflow on my branch - https://github.com/kramaranya/sdk/actions/runs/17457296258
PyPI project - https://pypi.org/project/kubeflow-test/
GitHub release - https://github.com/kramaranya/sdk/releases/tag/v0.8.1

coveralls · 2025-08-21T19:48:18Z

Pull Request Test Coverage Report for Build 17137367339

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.3%) to 64.877%

Totals
Change from base Build 17059769083:	0.3%
Covered Lines:	290
Relevant Lines:	447

💛 - Coveralls

coveralls · 2025-08-21T19:48:19Z

Pull Request Test Coverage Report for Build 17137367339

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.3%) to 64.877%

Totals
Change from base Build 17059769083:	0.3%
Covered Lines:	290
Relevant Lines:	447

💛 - Coveralls

coveralls · 2025-08-21T19:48:19Z

Pull Request Test Coverage Report for Build 17781819255

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
74 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.7%) to 71.739%

Files with Coverage Reduction	New Missed Lines	%
kubeflow/trainer/backends/kubernetes/backend.py	28	79.23%
kubeflow/trainer/utils/utils.py	46	64.25%

Totals
Change from base Build 17583649779:	0.7%
Covered Lines:	297
Relevant Lines:	414

💛 - Coveralls

szaher · 2025-08-21T22:11:15Z

@kramaranya You can convert it to draft till it's ready :)

kramaranya · 2025-09-01T22:30:18Z

/milestone v0.1

kramaranya · 2025-09-04T08:05:39Z

@kubeflow/kubeflow-sdk-team CI for automated release process should be ready, I would appreciate your reviews!

briangallagher · 2025-09-04T14:19:42Z

.github/workflows/prepare-release.yml

+        shell: bash
+        run: |
+          if git ls-remote --tags origin "${{ steps.vars.outputs.version }}" | grep -q "refs/tags/${{ steps.vars.outputs.version }}"; then
+            echo "Tag ${{ steps.vars.outputs.version }} already exists. Skipping CI."; exit 0; fi


Is the intention here to continue to the cherry pick even if the tag exists?

Yes initially, but now I think it makes sense to skip the cherry pick as well if the tag already exists
Let me update it!

briangallagher · 2025-09-04T14:22:38Z

.github/workflows/prepare-release.yml

+            echo "Using existing branch: $BRANCH"
+            git fetch origin "$BRANCH":"$BRANCH"
+            git checkout "$BRANCH"
+            if ! git cherry-pick -x "$MAIN_SHA"; then


Small suggestion: Add a check for the SHA before cherry-pick:
something like:

if git merge-base --is-ancestor "$MAIN_SHA" "$BRANCH"; then echo "Commit already present in $BRANCH" else git cherry-pick -x "$MAIN_SHA" fi

Good point, thank you!

briangallagher · 2025-09-04T14:24:11Z

Makefile

+release: uv-venv
+	@if [ -z "$(VERSION)" ]; then echo "Usage: make release VERSION=v0.1.0"; exit 1; fi
+	@VERSION_NUM=$$(echo "$(VERSION)" | sed 's/^v//'); \
+	sed -i '' "s/__version__ = \".*\"/__version__ = \"$$VERSION_NUM\"/" kubeflow/__init__.py; \


Will this work on non Mac?

Good catch! I created a small python script instead

@kramaranya FYI, if we want to make sed command align between Mac and Linux, we can install gnu-sed, like in Kueue: https://github.com/kubernetes-sigs/kueue/blob/main/Makefile#L72-L81

I see, thank you! I think sed -i.bak works as well, shall we just keep as it is right now and don't introduce any extra dependency?

@kramaranya sed -i.bak will work for MacOS and Linux ?

I think so, see https://en.wikipedia.org/wiki/Sed#In-place_editing and https://ss64.com/mac/sed.html

briangallagher

Added a few minor comments but overall this looks great.

kramaranya · 2025-09-06T08:29:22Z

@briangallagher I've addressed your comments, thank you for review!

/assign @briangallagher @andreyvelich @Electronic-Waste @astefanutti

kramaranya · 2025-09-15T15:09:24Z

I've tested this workflow on different scenarios and everything works:

RC - 0.9.0rc1
Minor release - 0.9.0
Patch release (on release-0.9 branch to test the case when we want to update patch release for previous releases) - 0.9.1

Signed-off-by: kramaranya <kramaranya15@gmail.com>

andreyvelich · 2025-09-15T15:20:20Z

This is awesome, thanks @kramaranya!
Just maybe one suggestion, shall we keep names of contributions without links, so they will get tagged in the GitHub release ?

feat: Implement TrainerClient Backends & Local Process ([#33](https://github.com/kubeflow/sdk/pull/33)) by [@szaher](https://github.com/szaher)

change to


feat: Implement TrainerClient Backends & Local Process ([#33](https://github.com/kubeflow/sdk/pull/33)) by @szaher

Example: https://github.com/kubeflow/trainer/releases/tag/v2.0.0

kramaranya · 2025-09-15T15:26:23Z

This is awesome, thanks @kramaranya! Just maybe one suggestion, shall we keep names of contributions without links, so they will get tagged in the GitHub release ?
feat: Implement TrainerClient Backends & Local Process ([#33](https://github.com/kubeflow/sdk/pull/33)) by [@szaher](https://github.com/szaher)

change to


feat: Implement TrainerClient Backends & Local Process ([#33](https://github.com/kubeflow/sdk/pull/33)) by @szaher
Example: https://github.com/kubeflow/trainer/releases/tag/v2.0.0

I've being trying to find the reason for that and wasn't sure since Trainer includes links in CHANGELOG.md. But sure, I'll update it, thank you!

andreyvelich · 2025-09-15T15:29:08Z

I've being trying to find the reason for that and wasn't sure since Trainer includes links in CHANGELOG.md

Yes, I think I've done this because usernames with @ are not clickable in the GitHub Markdown: https://github.com/kubeflow/trainer/blob/master/docs/release/changelog.py#L43

But I think this is fine, k8s changelog CLI also doesn't add links: https://github.com/kubernetes-sigs/kueue/blob/main/CHANGELOG/CHANGELOG-0.11.md

Signed-off-by: kramaranya <kramaranya15@gmail.com>

kramaranya · 2025-09-15T15:30:59Z

I've being trying to find the reason for that and wasn't sure since Trainer includes links in CHANGELOG.md

Yes, I think I've done this because usernames with @ are not clickable in the GitHub Markdown: https://github.com/kubeflow/trainer/blob/master/docs/release/changelog.py#L43

But I think this is fine, k8s changelog CLI also doesn't add links: https://github.com/kubernetes-sigs/kueue/blob/main/CHANGELOG/CHANGELOG-0.11.md

I see! Did you need to manually remove the links for every release?

andreyvelich · 2025-09-15T15:57:11Z

I see! Did you need to manually remove the links for every release?

Yes, we have this perl command to replace it: https://github.com/kubeflow/trainer/tree/c6997fcc36a7a771071a3f127fe192225a2f48b9/docs/release#create-github-release

andreyvelich

Thanks @kramaranya!
I think, we can move forward with this.
/lgtm
/assign @szaher @astefanutti @Electronic-Waste

Signed-off-by: kramaranya <kramaranya15@gmail.com>

andreyvelich · 2025-09-17T00:01:42Z

/approve
/hold
@kramaranya Feel free to un-hold this.

kramaranya · 2025-09-17T05:58:15Z

Thank you!
/unhold

kramaranya · 2025-09-17T05:59:12Z

/lgtm

google-oss-prow · 2025-09-17T05:59:14Z

@kramaranya: you cannot LGTM your own PR.

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Electronic-Waste

@kramaranya Thanks for this great contribution!
/lgtm
/approve

google-oss-prow · 2025-09-17T07:18:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andreyvelich, Electronic-Waste

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [Electronic-Waste,andreyvelich]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* feat(ci): Add release CI job Signed-off-by: kramaranya <kramaranya15@gmail.com> * feat(ci): Add GitHub Release to CI Signed-off-by: kramaranya <kramaranya15@gmail.com> * Change kubeflow sdk PyPI package name Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add kubeflow sdk version verification to CI Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add proper changelog extraction Signed-off-by: kramaranya <kramaranya15@gmail.com> * Allow to reuse test-python workflow Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add changelog generation script Signed-off-by: kramaranya <kramaranya15@gmail.com> * Update uv.lock Signed-off-by: kramaranya <kramaranya15@gmail.com> * Remove blank lines in changelog script Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add make release in Makefile Signed-off-by: kramaranya <kramaranya15@gmail.com> * Refactor gen_changelog Signed-off-by: kramaranya <kramaranya15@gmail.com> * Delete CHANGELOG.md Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add prepare-release CI Signed-off-by: kramaranya <kramaranya15@gmail.com> * Allow manual trigger of release CI Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add release readme Signed-off-by: kramaranya <kramaranya15@gmail.com> * Update chnagelog parser in CI Signed-off-by: kramaranya <kramaranya15@gmail.com> * skip and check cherry pick for new release Signed-off-by: kramaranya <kramaranya15@gmail.com> * add script to update the version Signed-off-by: kramaranya <kramaranya15@gmail.com> * Update make release script Signed-off-by: kramaranya <kramaranya15@gmail.com> * Use make test-python in release CI Signed-off-by: kramaranya <kramaranya15@gmail.com> * Move prepare release CI to one a single workflow Signed-off-by: kramaranya <kramaranya15@gmail.com> * Remove uv.sync from RELEASE.md Signed-off-by: kramaranya <kramaranya15@gmail.com> * Upload artifacts to GitHub Release Signed-off-by: kramaranya <kramaranya15@gmail.com> * Run release CI against release-* branch Signed-off-by: kramaranya <kramaranya15@gmail.com> * Use X.Y.Z versioning in Kubeflow SDK Signed-off-by: kramaranya <kramaranya15@gmail.com> * Use single workflow for release Signed-off-by: kramaranya <kramaranya15@gmail.com> * Remove Release types from RELEASE.md Signed-off-by: kramaranya <kramaranya15@gmail.com> * Add a note about older minor series patch release Signed-off-by: kramaranya <kramaranya15@gmail.com> * Directly checkout release branch with ref input Signed-off-by: kramaranya <kramaranya15@gmail.com> * Checkout release branch with ref input Signed-off-by: kramaranya <kramaranya15@gmail.com> * Update extract changelog job Signed-off-by: kramaranya <kramaranya15@gmail.com> * Update the name of github release Signed-off-by: kramaranya <kramaranya15@gmail.com> * Remove full changelog line Signed-off-by: kramaranya <kramaranya15@gmail.com> * Fix ruff issue Signed-off-by: kramaranya <kramaranya15@gmail.com> * Don't use link for authors in changelog Signed-off-by: kramaranya <kramaranya15@gmail.com> * Remove chnagelog for RCs Signed-off-by: kramaranya <kramaranya15@gmail.com> --------- Signed-off-by: kramaranya <kramaranya15@gmail.com>

google-oss-prow bot added the do-not-merge/work-in-progress label Aug 21, 2025

google-oss-prow bot requested review from Electronic-Waste, andreyvelich and astefanutti August 21, 2025 19:46

google-oss-prow bot added the size/L label Aug 21, 2025

kramaranya marked this pull request as draft August 22, 2025 09:12

kramaranya force-pushed the auto-release branch from 6c13496 to b95afe5 Compare August 22, 2025 23:54

kramaranya mentioned this pull request Aug 26, 2025

[Release] Kubeflow SDK 0.1 Release #45

Closed

12 tasks

kramaranya force-pushed the auto-release branch from 0c219ee to b966105 Compare August 26, 2025 22:58

kramaranya marked this pull request as ready for review August 27, 2025 07:27

google-oss-prow bot added this to the v0.1 milestone Sep 1, 2025

google-oss-prow bot added size/XL size/L and removed size/L size/XL labels Sep 3, 2025

kramaranya changed the title ~~WIP: feat(ci): Add automated release CI job~~ feat(ci): Add automated release CI job Sep 4, 2025

google-oss-prow bot removed the do-not-merge/work-in-progress label Sep 4, 2025

briangallagher reviewed Sep 4, 2025

View reviewed changes

google-oss-prow bot assigned szaher Sep 15, 2025

google-oss-prow bot added the lgtm label Sep 15, 2025

Remove full changelog line

2057a66

Signed-off-by: kramaranya <kramaranya15@gmail.com>

google-oss-prow bot removed the lgtm label Sep 15, 2025

Fix ruff issue

74de8ca

Signed-off-by: kramaranya <kramaranya15@gmail.com>

Don't use link for authors in changelog

ed4363d

Signed-off-by: kramaranya <kramaranya15@gmail.com>

andreyvelich reviewed Sep 15, 2025

View reviewed changes

google-oss-prow bot added the lgtm label Sep 15, 2025

Remove chnagelog for RCs

290b2a4

Signed-off-by: kramaranya <kramaranya15@gmail.com>

google-oss-prow bot removed the lgtm label Sep 16, 2025

google-oss-prow bot added do-not-merge/hold approved labels Sep 17, 2025

google-oss-prow bot removed the do-not-merge/hold label Sep 17, 2025

kramaranya mentioned this pull request Sep 17, 2025

Kubeflow SDK Official Release 0.1.0rc1 #100

Merged

Electronic-Waste approved these changes Sep 17, 2025

View reviewed changes

google-oss-prow bot added the lgtm label Sep 17, 2025

google-oss-prow bot merged commit ba22c64 into kubeflow:main Sep 17, 2025
10 checks passed

kramaranya mentioned this pull request Sep 17, 2025

Build and Release Kubeflow to pypi #36

Closed

1 task

feat(ci): Add automated release CI job #65

feat(ci): Add automated release CI job #65

Conversation

kramaranya commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Aug 21, 2025

Pull Request Test Coverage Report for Build 17137367339

Details

💛 - Coveralls

Uh oh!

coveralls commented Aug 21, 2025

Pull Request Test Coverage Report for Build 17137367339

Details

💛 - Coveralls

Uh oh!

coveralls commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 17781819255

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

szaher commented Aug 21, 2025

Uh oh!

kramaranya commented Sep 1, 2025

Uh oh!

kramaranya commented Sep 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

briangallagher Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

briangallagher left a comment

Choose a reason for hiding this comment

Uh oh!

kramaranya commented Sep 6, 2025

Uh oh!

kramaranya commented Sep 15, 2025

Uh oh!

andreyvelich commented Sep 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kramaranya commented Sep 15, 2025

Uh oh!

andreyvelich commented Sep 15, 2025

Uh oh!

kramaranya commented Sep 15, 2025

Uh oh!

andreyvelich commented Sep 15, 2025

Uh oh!

andreyvelich left a comment

Choose a reason for hiding this comment

Uh oh!

andreyvelich commented Sep 17, 2025

Uh oh!

kramaranya commented Sep 17, 2025

Uh oh!

kramaranya commented Sep 17, 2025

Uh oh!

google-oss-prow bot commented Sep 17, 2025

Uh oh!

kramaranya commented Aug 21, 2025 •

edited

Loading

coveralls commented Aug 21, 2025 •

edited

Loading

briangallagher Sep 4, 2025 •

edited

Loading

andreyvelich commented Sep 15, 2025 •

edited

Loading