[RHOAIENG-24973] [RHOAIENG-26615] Created notebooks-digest-updater.yaml and update-buildconfigs.yaml to automate the release of notebooks with the github action call: Notebooks Release #1150

mtchoum1 · 2025-06-06T15:27:52Z

Automated Notebooks Releases

Description

[RHOAIENG-24973]
.github/workflows/notebooks-release.yaml: Created to facilitate notebook releases by calling .github/workflows/notebooks-digest-updater.yaml and .github/workflows/update-buildconfigs.yaml. This workflow allows users to optionally update build configurations and input the release version and name.

[RHOAIENG-26615]
.github/workflows/update-buildconfigs.yaml: Created to update build configuration files in the manifest. This workflow can be run independently or called by the notebook release workflow. You can input a version; if left blank, it will simply increment the last version by one.

How Has This Been Tested?

[RHOAIENG-24973]
By running the GitHub Action on my own repository using the branch tmp-digest-sync-14488482962 to simulate the output of .github/workflows/notebooks-digest-updater.yaml
[RHOAIENG-26615]
By running the Github Action on my own repository checking the pull request created to make sure the version was changing correct based on the input given. Also tested it being called by the .github/workflows/update-buildconfigs.yaml

Merge criteria:

The commits are squashed in a cohesive manner and have meaningful messages.
Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
The developer has manually tested the changes and verified that the changes work

openshift-ci · 2025-06-06T15:28:00Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign caponetto for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

openshift-ci · 2025-06-06T15:28:06Z

Hi @mtchoum1. Thanks for your PR.

I'm waiting for a opendatahub-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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-sigs/prow repository.

harshad16 · 2025-06-06T16:20:16Z

/ok-to-test

jstourac · 2025-06-09T07:32:24Z

.github/workflows/update-buildconfigs.yaml

+          cat tmp.yaml > ./manifests/base/cuda-rstudio-buildconfig.yaml
+          rm tmp.yaml
+
+      - name: Update BuildConfig for RStudio


Just wondering why not to keep both rstudio updates in one step? Not a big deal though.

It could be done, I did it just so I knew both we're completed

jstourac · 2025-06-09T07:35:35Z

.github/workflows/update-buildconfigs.yaml

+jobs:
+  buidConfigs:
+    runs-on: ubuntu-latest
+    if: inputs.version == ''


I wonder whether instead of having different job for each variant meaning having the duplicate code, we couldn't have an extra step that would define a new variable depending on the inputs.version value - either use it directly or count a new value for us. This new variable would then be used by the followup steps. WDYT?

That's an excellent idea! I'll definitely try to implement that.

jstourac · 2025-06-09T07:37:47Z

.github/workflows/notebooks-digest-updater.yaml


 env:
-  USER_HASH: ${{ github.event.inputs.user-hash }}
+  USER_HASH: ${{ inputs.user-hash }}


Can you elaborate on why this change? Is it because of the added workflow_call option above? But I wonder why it wasn't a problem for the workflow_dispatch then 🤔 or is it because of the external call from the notebook-release.yaml?

Yes, From my understanding and testing if you use workflow_call you have to use input.user-hash instead of the github.event.input.userhash if there's external call

jstourac · 2025-06-09T07:42:58Z

.github/workflows/notebooks-release.yaml

+
+              if [ "$PR_STATE" = "null" ] || [ -z "$PR_STATE" ]; then
+                echo "PR #$PR_NUMBER is not merged yet. Waiting..."
+                sleep 1


Hm, I'm not sure I like the waiting step. At least we should probably sleep for more than 1 second.

Anyway, how do we expect the manifest PR to be merged? Is it gonna be automatically as we discussed last week?

Anyway, how do we expect the manifest PR to be merged? Is it gonna be automatically as we discussed last week?

By hand I figure, same as in Kubeflow repo. Until something more is implemented.

Yeah, my expectation was that we plan to wait for the odh on konflux.

Quite likely, that's why I was complaining about refining the automerge issue right now, since whatever we decide will be invalidated by the time we end up implementing.

Anyways, these concerns don't affect this PR at all, IMO.

atheo89

Thank for this work Moryan, I am adding a few suggestions that could help reduce redundancy and improve maintainability in update-buildconfig.yaml workflow:

There's a lot of repeated code between the two jobs (buidConfigs and buidConfigs_with_version).
It would be cleaner to extract the logic into a reusable bash script (e.g., buildconfig-updater.sh) and call it with the version as an argument:

./build-config-updater.sh ${{ env.VERSION }}

Inside the script, you can handle version logic conditionally:

if [[ -z "$VERSION" ]]; then
  # Auto-increment version logic
else
  # Use provided version logic
fi

Moreover, as Jan pointed out, there's no need to have separate steps for updating cuda-rstudio and rstudio buildconfigs. If the above suggestion isn’t followed, at the very least, these two very similar blocks could be merged into one to reduce duplication.

Lastly, please update the pull request title and description to reference both related issues: RHOAIENG-24975 and RHOAIENG-24973. I'd recommend keeping the scope of each workflow or pull request as small as reasonably possible. Smaller, focused changes generally move through review quicker and make life easier for both developers and reviewers.

Thanks!

…thub action call: Notebooks Release

…hin the job rather that for the job itself and changed the merge check to be the same as kubeflow

atheo89 · 2025-06-10T07:44:53Z

.github/workflows/notebooks-release.yaml

@@ -0,0 +1,206 @@
+---


Could you add two options to this GitHub Action?

Release: This should work as it currently does, including all jobs (digest updater, build config, release etc.).

Sync: This should trigger only the digest updater. The release and build config jobs should not be triggered.

The Sync option is important to ensure that params-latest.env stays regularly updated. This will support future plans to use ODH nightlies and, potentially, set up a daily cron job for automatic syncing. The Release option would then be used only on demand for actual releases.

Yes, They have something similar in kubeflow release, I can replicate what they have done

atheo89 · 2025-06-10T07:45:25Z

.github/workflows/notebooks-release.yaml

+  VERSION: ${{ github.event.inputs.buildconfigs_version}}
+
+jobs:
+  #1. Update the params.env and commit.env files with new SHAs


Suggested change

#1. Update the params.env and commit.env files with new SHAs

#1. Update the params-latest.env and commit-latest.env files with new SHAs

… automate the release of notebooks with the github action call: Notebooks Release

openshift-ci bot requested review from atheo89 and jiridanek June 6, 2025 15:27

openshift-ci bot added size/l needs-ok-to-test labels Jun 6, 2025

openshift-ci bot added ok-to-test and removed needs-ok-to-test labels Jun 6, 2025

mtchoum1 force-pushed the notebooks-release-v3 branch from 1e611de to f277c3d Compare June 6, 2025 17:13

openshift-ci bot added size/l and removed size/l labels Jun 6, 2025

mtchoum1 force-pushed the notebooks-release-v3 branch from f277c3d to 6614bc6 Compare June 6, 2025 17:17

openshift-ci bot added size/l and removed size/l labels Jun 6, 2025

jstourac reviewed Jun 9, 2025

View reviewed changes

atheo89 reviewed Jun 9, 2025

View reviewed changes

openshift-ci bot added size/l and removed size/l labels Jun 9, 2025

mtchoum1 force-pushed the notebooks-release-v3 branch from 4056aca to 7f4189c Compare June 9, 2025 14:47

openshift-ci bot removed the size/l label Jun 9, 2025

Create various files to automate the release of notebooks with the gi…

77215f4

…thub action call: Notebooks Release

mtchoum1 force-pushed the notebooks-release-v3 branch from 7f4189c to 77215f4 Compare June 9, 2025 15:02

openshift-ci bot added size/l and removed size/l labels Jun 9, 2025

Remove redundancy in the by implemneting the version if statement wit…

3de2a82

…hin the job rather that for the job itself and changed the merge check to be the same as kubeflow

openshift-ci bot added size/l and removed size/l labels Jun 9, 2025

atheo89 reviewed Jun 10, 2025

View reviewed changes

openshift-ci bot added size/l and removed size/l labels Jun 10, 2025

mtchoum1 force-pushed the notebooks-release-v3 branch from 3973e88 to 3e93e70 Compare June 10, 2025 14:54

openshift-ci bot added size/l and removed size/l labels Jun 10, 2025

mtchoum1 force-pushed the notebooks-release-v3 branch from 8cb77d3 to 8767783 Compare June 10, 2025 14:57

openshift-ci bot added size/l and removed size/l labels Jun 10, 2025

Created notebooks-digest-updater.yaml and update-buildconfigs.yaml to…

712e4da

… automate the release of notebooks with the github action call: Notebooks Release

mtchoum1 force-pushed the notebooks-release-v3 branch from 8767783 to 712e4da Compare June 10, 2025 15:08

openshift-ci bot added size/l and removed size/l labels Jun 10, 2025

	#1. Update the params.env and commit.env files with new SHAs
	#1. Update the params-latest.env and commit-latest.env files with new SHAs

[RHOAIENG-24973] [RHOAIENG-26615] Created notebooks-digest-updater.yaml and update-buildconfigs.yaml to automate the release of notebooks with the github action call: Notebooks Release #1150

Are you sure you want to change the base?

[RHOAIENG-24973] [RHOAIENG-26615] Created notebooks-digest-updater.yaml and update-buildconfigs.yaml to automate the release of notebooks with the github action call: Notebooks Release #1150

Uh oh!

Conversation

mtchoum1 commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Merge criteria:

Uh oh!

openshift-ci bot commented Jun 6, 2025

Uh oh!

openshift-ci bot commented Jun 6, 2025

Uh oh!

harshad16 commented Jun 6, 2025

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!

mtchoum1 Jun 9, 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!

jstourac Jun 9, 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!

jiridanek Jun 9, 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!

atheo89 left a comment • 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!

Uh oh!

mtchoum1 commented Jun 6, 2025 •

edited

Loading

mtchoum1 Jun 9, 2025 •

edited

Loading

jstourac Jun 9, 2025 •

edited

Loading

jiridanek Jun 9, 2025 •

edited

Loading

atheo89 left a comment •

edited

Loading