Skip to content
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

OPRUN-3021: Improve README #529

Merged
merged 1 commit into from
Aug 1, 2023

Conversation

tmshort
Copy link
Contributor

@tmshort tmshort commented Aug 1, 2023

Add additional information to the README files.
Add help for the sync scripts

@openshift-ci-robot
Copy link

openshift-ci-robot commented Aug 1, 2023

@tmshort: This pull request references OPRUN-3021 which is a valid jira issue.

In response to this:

Add additional information to the README files.
Add help for the sync scripts

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.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 1, 2023
Copy link
Contributor

@stevekuznetsov stevekuznetsov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks awesome, thank you!

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2023
Copy link
Member

@dinhxuanvu dinhxuanvu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 1, 2023
@tmshort
Copy link
Contributor Author

tmshort commented Aug 1, 2023

Since this is just readme and the sync scripts, we can probably ignore the e2e tests? (i.e. /override)
@dinhxuanvu @stevekuznetsov you ok with that?


Even if you only have a single commit, this procedure will follow the same
process that `sync.sh` does, to ensure no steps are missed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't sync_pop_candidate.sh also make manifests, vendor, etc. in ways that sync.sh does not?
(And also, sync_pop_candidate.sh needs to make verify-manifests in order to satisfy CI.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sync.sh calls sync_pop_candidate.sh

But nothing seems to call make verify or make verify-manifests

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to document the need to do a make verify but fixing the downstreaming scripts to do that is a bit more involved, so I'd rather save that for another PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My point was really more about the statement about 'will follow the same process' when there is a behavior gap between the scripts.
for e.g.:

Copy link
Contributor Author

@tmshort tmshort Aug 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it is the same process. The sync.sh script:

  1. The upstream repositories are added as remotes to the monorepo.
  2. The upstream repositories are fetched.
  3. A merge branch with the current date (sync-YYYY-MM-DD) is created to do the bulk sync.
  4. Create a list of candidate commits from upstream to downstream via sync_get_candidates.sh
  5. Apply each commit via sync_pop_candidate.sh

The sync.sh script literally calls sync_pop_candidate.sh to do all the work for a list of commits (generated by sync_get_candidates.sh).

The problem is that there's additional verification steps via make verify/make verify-manifests, that need to occur.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Argh! You're completely correct. I missed the call to sync_pop_candidates.sh. ☹️
Thanks for the sanity.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO we should solve the verification "additional steps" problem in changes to sync_pop_candidates.sh in another PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed.

@dinhxuanvu
Copy link
Member

@tmshort I have no problem with merging it manually as it is just a doc change.

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2023
Add additional information to the README files.
Add help for the sync scripts

Signed-off-by: Todd Short <todd.short@me.com>
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2023
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dinhxuanvu, grokspawn, stevekuznetsov, tmshort

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:

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

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2023
@stevekuznetsov
Copy link
Contributor

FWIW Tide will re-test even when there are overrides but yea seems fine to override

@stevekuznetsov
Copy link
Contributor

Also can configure e2e to skip docs

@grokspawn
Copy link
Contributor

/lgtm

re-lgtm-ing

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 1, 2023
@tmshort
Copy link
Contributor Author

tmshort commented Aug 1, 2023

/override e2e-gcp-console-olm
/override e2e-gcp-olm
/override e2e-gcp-ovm
/override e2e-upgrade

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2023

@tmshort: tmshort unauthorized: /override is restricted to Repo administrators, approvers in top level OWNERS file, and the following github teams:openshift: openshift-release-oversight.

In response to this:

/override e2e-gcp-console-olm
/override e2e-gcp-olm
/override e2e-gcp-ovm
/override e2e-upgrade

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.

@tmshort
Copy link
Contributor Author

tmshort commented Aug 1, 2023

(looks as though I can't override)

@tmshort
Copy link
Contributor Author

tmshort commented Aug 1, 2023

/retest
Or could an OWNER /override e2e-gcp-olm ?

@dinhxuanvu
Copy link
Member

/override e2e-gcp-olm

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2023

@dinhxuanvu: /override requires failed status contexts, check run or a prowjob name to operate on.
The following unknown contexts/checkruns were given:

  • e2e-gcp-olm

Only the following failed contexts/checkruns were expected:

  • ci/prow/e2e-gcp-console-olm
  • ci/prow/e2e-gcp-olm
  • ci/prow/e2e-gcp-olm-flaky
  • ci/prow/e2e-gcp-ovn
  • ci/prow/e2e-upgrade
  • ci/prow/images
  • ci/prow/unit-api
  • ci/prow/unit-olm
  • ci/prow/unit-psm
  • ci/prow/unit-registry
  • ci/prow/verify
  • pull-ci-openshift-operator-framework-olm-master-e2e-gcp-console-olm
  • pull-ci-openshift-operator-framework-olm-master-e2e-gcp-olm
  • pull-ci-openshift-operator-framework-olm-master-e2e-gcp-olm-flaky
  • pull-ci-openshift-operator-framework-olm-master-e2e-gcp-ovn
  • pull-ci-openshift-operator-framework-olm-master-e2e-upgrade
  • pull-ci-openshift-operator-framework-olm-master-images
  • pull-ci-openshift-operator-framework-olm-master-unit-api
  • pull-ci-openshift-operator-framework-olm-master-unit-olm
  • pull-ci-openshift-operator-framework-olm-master-unit-psm
  • pull-ci-openshift-operator-framework-olm-master-unit-registry
  • pull-ci-openshift-operator-framework-olm-master-verify
  • tide

If you are trying to override a checkrun that has a space in it, you must put a double quote on the context.

In response to this:

/override e2e-gcp-olm

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.

@dinhxuanvu
Copy link
Member

/override ci/prow/e2e-gcp-olm

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2023

@dinhxuanvu: Overrode contexts on behalf of dinhxuanvu: ci/prow/e2e-gcp-olm

In response to this:

/override ci/prow/e2e-gcp-olm

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.

@openshift-merge-robot openshift-merge-robot merged commit d5108bd into openshift:master Aug 1, 2023
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 1, 2023

@tmshort: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@tmshort tmshort deleted the update-readme branch August 1, 2023 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants