docs: update workflow and how we use two branchs for ODH and downstream by zdtsw · Pull Request #1582 · opendatahub-io/opendatahub-operator

zdtsw · 2025-01-29T10:15:43Z

Description

https://issues.redhat.com/browse/RHOAIENG-498

How Has This Been Tested?

Screenshot or short clip

Merge criteria

You have read the contributors guide.
Commit messages are meaningful - have a clear and concise summary and detailed explanation of what was changed and why.
Pull Request contains a description of the solution, a link to the JIRA issue, and to any dependent or related Pull Request.
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

codecov · 2025-01-29T10:28:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.94%. Comparing base (cb2baa9) to head (fc4165c).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1582   +/-   ##
=======================================
  Coverage   19.94%   19.94%           
=======================================
  Files         158      158           
  Lines       10799    10799           
=======================================
  Hits         2154     2154           
  Misses       8415     8415           
  Partials      230      230

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ykaliuta · 2025-01-29T11:04:59Z

    branches:
      - main
      - incubation
+      - rhoai


not really a doc

removed, put in #1593 for change

ykaliuta · 2025-01-29T11:05:39Z

-3. **Operator Bundle or Dockerfile Updates:** If changes affect the operator bundle or Dockerfile, sync the changes in the `rhods-cpaas-midstream` repo in addition to downstream PR.
-
-Follow the same [PR Guide](#pull-requests) for creating and reviewing downstream PRs.
+detail see (./docs/sync_code.md#basci-workflow-for-operator)


probably a typo, basic

ykaliuta · 2025-01-29T11:06:24Z

+Start by creating a branch from "main" branch.
+
+2. Ensure local tests pass:
+Run unit and e2e tests, and ensure they pass before submitting a pull request (PR) targeting "main" branch.


will we switch to jira-XXX-name branch naming at the same time?

the branch is created in the users' fork git repo, can be named any way they would like to. i do not think we need suggest that part.

ykaliuta · 2025-01-29T11:08:49Z

+
+
+3. Review and merge PR:
+Once the PR has passed github checks and is reviewed and approved, the PR author should merge it into "main" branch.


Is author really involved? Was it bot or maintainer?

in my experience:
either i need to enable auto-merge myself or i need to manually click "merge" or someone helps to click "merge/auto-merge" for me, prow does not help in a 100% reliable way.
until it is fully automated without so many "exceptions", i would prefer the author of the PR follow it till the end.
if the author is a community user, then might have problem to "merge", maintainer can be tagged for such cases. this could also happens when these PR need to get into downstream.

ykaliuta · 2025-01-29T11:11:15Z

+6. Automated sync:
+Automation will sync changes to the RHDS rhods-operator on a daily basis.
+
+# PR labels


Are we allowed to set labels?

I was hoping that the /label command could be used for that, but it seems that it's a static list of labels specific to openshift that are allowed for that. Maybe something could be added to the config in openshift/release for it, not sure 🤔

i think manitainers should have permission to set label.
at least i used labels a lot both for my PR and the PR i was asked to review or triage.

also i do not know how it will be with these prow bot, when we move to konflux, do we still need prow, will /cmd still work etc.
if we do not want to depend on an external system, e.g prow, native feature of GH like create/add labels should always work, (i hope)

ykaliuta · 2025-01-29T11:14:29Z

+5. Merge sync PR:
+After the sync PR has passed github checks and is reviewed and approved, the PR author should merge it into "rhoai" branch.
+
+6. Automated sync:


not sure it should be in the ODH repo. Does not affect any related workflow according to the description.

put it here only as information.
if everyone is clear about this, because i got asked many times in the past, i can remove it

ykaliuta · 2025-01-29T11:15:06Z

+3. Review and merge PR:
+Once the PR has passed github checks and is reviewed and approved, the PR author should merge it into "main" branch.
+
+4. Create a downstream sync PR:


Just double checking, it's now part of process for any author.

it can be different.
if we would like, we can have two different cases:
-for community user
-for the most active users of this git repo normally the maintainer/platform team members.

i drafted this PR purely for the later case, but then the responsibilty for who should get such sync PR to downstream is not defined. we will need another discussion internally for that.
but that can be done in a follow up PR once we know more. wdyt?

grdryn · 2025-01-29T23:17:47Z

/label rhoai

openshift-ci · 2025-01-29T23:17:49Z

@grdryn: The label(s) /label rhoai cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, no-qe, downstream-change-needed, rebase/manual, cluster-config-api-changed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, jira/valid-bug, staff-eng-approved. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

Details

In response to this:

/label rhoai

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.

grdryn · 2025-01-29T23:20:32Z

+6. Automated sync:
+Automation will sync changes to the RHDS rhods-operator on a daily basis.
+
+# PR labels


I was hoping that the /label command could be used for that, but it seems that it's a static list of labels specific to openshift that are allowed for that. Maybe something could be added to the config in openshift/release for it, not sure 🤔

- add new doc for how workflow, label on PR, sync process - update branch away from incubatin in github action and reference Signed-off-by: Wen Zhou <wenzhou@redhat.com>

Co-authored-by: Gerard Ryan <git@grdryn.xyz>

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

openshift-ci · 2025-01-30T08:55:53Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ugiordan, ykaliuta

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [ugiordan,ykaliuta]

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

…am (opendatahub-io#1582) * docs: update workflow and how we use two branchs for ODH and downstream - add new doc for how workflow, label on PR, sync process - update branch away from incubatin in github action and reference Signed-off-by: Wen Zhou <wenzhou@redhat.com> * Update docs/sync_code.md Co-authored-by: Gerard Ryan <git@grdryn.xyz> * revert: branch related test config Signed-off-by: Wen Zhou <wenzhou@redhat.com> * fix: typo Signed-off-by: Wen Zhou <wenzhou@redhat.com> --------- Signed-off-by: Wen Zhou <wenzhou@redhat.com> Co-authored-by: Gerard Ryan <git@grdryn.xyz> (cherry picked from commit da75d42)

…am (#1582) (#1636) * docs: update workflow and how we use two branchs for ODH and downstream - add new doc for how workflow, label on PR, sync process - update branch away from incubatin in github action and reference Signed-off-by: Wen Zhou <wenzhou@redhat.com> * Update docs/sync_code.md Co-authored-by: Gerard Ryan <git@grdryn.xyz> * revert: branch related test config Signed-off-by: Wen Zhou <wenzhou@redhat.com> * fix: typo Signed-off-by: Wen Zhou <wenzhou@redhat.com> --------- Signed-off-by: Wen Zhou <wenzhou@redhat.com> Co-authored-by: Gerard Ryan <git@grdryn.xyz> (cherry picked from commit da75d42)

* chore: cleanup kustomize config (#1497) - suspend too many WARNING lines from "make bundle" - remove sample config for components and monitoring Signed-off-by: Wen Zhou <wenzhou@redhat.com> (cherry picked from commit 4fe5bed) * chore: add more rules in golint (#1487) - add rules for our API components and service which force alias to be named with suffix ctrl Signed-off-by: Wen Zhou <wenzhou@redhat.com> (cherry picked from commit 32d75a8) * update: clean up old code before refactor (#1494) * update: clean up old code before refactor - remove reference we explicilty check on odhdashboardconfig and kserve - remove customized config on controller QPS - remove RemoveLabel which is not called anywhere Signed-off-by: Wen Zhou <wenzhou@redhat.com> * update: - remove function for upgrade cleanup introduced before 2.8 - remove flags to main: operator namespace and application namespace ( operator namespace is passing as env variable, app namespace is done by DSCI ) Signed-off-by: Wen Zhou <wenzhou@redhat.com> * fix: Auth CR is cluster-scoped no need to set namespace for request - application namespace is removed from reconciler of dsci Signed-off-by: Wen Zhou <wenzhou@redhat.com> * fix: wrong code for upgrade path + rebase error Signed-off-by: Wen Zhou <wenzhou@redhat.com> --------- Signed-off-by: Wen Zhou <wenzhou@redhat.com> (cherry picked from commit b0a0f87) * docs: update workflow and how we use two branchs for ODH and downstream (#1582) * docs: update workflow and how we use two branchs for ODH and downstream - add new doc for how workflow, label on PR, sync process - update branch away from incubatin in github action and reference Signed-off-by: Wen Zhou <wenzhou@redhat.com> * Update docs/sync_code.md Co-authored-by: Gerard Ryan <git@grdryn.xyz> * revert: branch related test config Signed-off-by: Wen Zhou <wenzhou@redhat.com> * fix: typo Signed-off-by: Wen Zhou <wenzhou@redhat.com> --------- Signed-off-by: Wen Zhou <wenzhou@redhat.com> Co-authored-by: Gerard Ryan <git@grdryn.xyz> (cherry picked from commit da75d42) * update: platform team (#1583) Signed-off-by: Wen Zhou <wenzhou@redhat.com> (cherry picked from commit 46d8ba2) * Remove Sara4994 from OWNER_ALIASES (#1598) (cherry picked from commit bf8a6e2) * github: add branch into GHA for tests (#1593) Signed-off-by: Wen Zhou <wenzhou@redhat.com> (cherry picked from commit f4c932b) * apis: DSCInitialization: annotate ApplicationsNamespace with omitempty (#1585) Jira: https://issues.redhat.com/browse/RHOAIENG-18931 Api sets default value to opendatahub, but without "omitempty" in case of operator automatically creates DSCI (upgrade.go:CreateDefaultDSCI), the resulting object contains applicationsNamespace: "" and it's not defaulted by the api server causing then problems like ``` Namespace "" is invalid: metadata.name: Required value: name or generateName is required ``` The problem was triggered by removing default value for command line switch in the cleanup. Fixes: b0a0f87 ("update: clean up old code before refactor (#1494)") Signed-off-by: Yauheni Kaliuta <ykaliuta@redhat.com> (cherry picked from commit 768539c) * regen bundle (#1602) (cherry picked from commit 2384ada) * test: prolong e2e in rhoai for 50mins Signed-off-by: Wen Zhou <wenzhou@redhat.com> * fix:default monitoring namespace Signed-off-by: Wen Zhou <wenzhou@redhat.com> --------- Signed-off-by: Wen Zhou <wenzhou@redhat.com> Co-authored-by: Ajay Jaganathan <36824134+AjayJagan@users.noreply.github.com> Co-authored-by: Yauheni Kaliuta <ykaliuta@redhat.com> Co-authored-by: Luca Burgazzoli <lburgazzoli@users.noreply.github.com>

zdtsw added the documentation Improvements or additions to documentation label Jan 29, 2025

openshift-ci Bot requested review from StevenTobin and lphiri January 29, 2025 10:15

zdtsw requested review from ugiordan and removed request for StevenTobin and lphiri January 29, 2025 10:15

zdtsw changed the title ~~docs: update workflow and how we use two branchs for ODH and downstream~~ [WIP] docs: update workflow and how we use two branchs for ODH and downstream Jan 29, 2025

openshift-ci Bot added the do-not-merge/work-in-progress label Jan 29, 2025

zdtsw force-pushed the jira_498 branch from e445f93 to b6f8f49 Compare January 29, 2025 10:55

zdtsw changed the title ~~[WIP] docs: update workflow and how we use two branchs for ODH and downstream~~ docs: update workflow and how we use two branchs for ODH and downstream Jan 29, 2025

openshift-ci Bot removed the do-not-merge/work-in-progress label Jan 29, 2025

zdtsw requested review from AjayJagan, VaishnaviHire and grdryn January 29, 2025 10:56

ykaliuta reviewed Jan 29, 2025

View reviewed changes

grdryn reviewed Jan 29, 2025

View reviewed changes

zdtsw and others added 4 commits January 30, 2025 08:56

docs: update workflow and how we use two branchs for ODH and downstream

0e7cef0

- add new doc for how workflow, label on PR, sync process - update branch away from incubatin in github action and reference Signed-off-by: Wen Zhou <wenzhou@redhat.com>

Update docs/sync_code.md

e81c447

Co-authored-by: Gerard Ryan <git@grdryn.xyz>

revert: branch related test config

ce5066e

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

fix: typo

fc4165c

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

zdtsw force-pushed the jira_498 branch from 30ef248 to fc4165c Compare January 30, 2025 08:00

ugiordan approved these changes Jan 30, 2025

View reviewed changes

openshift-ci Bot assigned ugiordan Jan 30, 2025

openshift-ci Bot added lgtm approved labels Jan 30, 2025

ykaliuta approved these changes Jan 30, 2025

View reviewed changes

openshift-ci Bot assigned ykaliuta Jan 30, 2025

openshift-merge-bot Bot merged commit da75d42 into opendatahub-io:main Jan 30, 2025



		3. Review and merge PR:
		Once the PR has passed github checks and is reviewed and approved, the PR author should merge it into "main" branch.

Conversation

zdtsw commented Jan 29, 2025

Description

How Has This Been Tested?

Screenshot or short clip

Merge criteria

Uh oh!

codecov Bot commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

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!

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!

grdryn commented Jan 29, 2025

Uh oh!

openshift-ci Bot commented Jan 29, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci Bot commented Jan 30, 2025

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Jan 29, 2025 •

edited

Loading