Skip to content

Commit

Permalink
Update downstreaming documentation.
Browse files Browse the repository at this point in the history
Also remove the bumper code as it has been moved.

Signed-off-by: Todd Short <todd.short@me.com>
  • Loading branch information
tmshort committed Nov 1, 2023
1 parent 57e26f0 commit 52646fb
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 1,742 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -14,3 +14,5 @@ above), and then downstreamed to this repository.

Please refer to the [scripts README.md](scripts/README.md) to learn how to
downstream commits from those projects to this repo.

A [TestGrid](https://testgrid.k8s.io/redhat-openshift-olm) is configured for this repository.
26 changes: 22 additions & 4 deletions scripts/README.md
Expand Up @@ -5,6 +5,17 @@ All of the staged repositories live in the top level `staging` directory.
The downstreaming process is complex and helper scripts have been written
to facilitate downstreaming.

## Automatic Downstreaming

There is now an automated downstreaming process for OLMv0 from the three
source repositories.

The "bumper" program is located in [openshift/operator-framework-tooling](https://github.com/openshift/operator-framework-tooling).
It is automatically run on a daily basis based on the following [openshift/release](https://github.com/openshift/release/blob/3bf0b3ae011debaefefb564ad6f233c380d033f7/ci-operator/jobs/infra-periodics.yaml#L926-L978) config.

If the bumper program fails to create a mergeable PR, manual intervention will be necessary.
This may require copying, modifying and resubmitting the PR.

## Assumptions

The helper scripts assume that the upstream remote repos are configured
Expand All @@ -19,6 +30,9 @@ remote repositories.

## Bulk Sync

**NOTE**: This should no longer be necessary, given the "bumper" program above.
The "bumper" program can be used instead of the following process.

To sync all current changes from upstream, simply run the sync script:
```sh
scripts/sync.sh
Expand Down Expand Up @@ -54,14 +68,18 @@ file in the repositry root directory with the repos and commit SHAs.

The format of the cherrypick file is:
```
<order> <repo> <commit-SHA>
<date-order> <commit-order> <repo> <commit-SHA>
```

* The `<date-order>` field is usually an ISO date without spaces.
* The `<commit-order>` field is a sequential number indicating the order of a commit within a pull request.
* For this _manual_ purpose, both can just be the same sequential number.

For example:
```
1 api 0123456789abcdef0123456789abcdef01234567
2 operator-lifecycle-manager 123456789abcdef0123456789abcdef012345678
3 operator-lifecycle-manager 23456789abcdef0123456789abcdef0123456789
1 1 api 0123456789abcdef0123456789abcdef01234567
2 2 operator-lifecycle-manager 123456789abcdef0123456789abcdef012345678
3 3 operator-lifecycle-manager 23456789abcdef0123456789abcdef0123456789
```
Do _not_ commit the cherrypick file, it is a temporary working file that
is ignored by `git`.
Expand Down
1 change: 0 additions & 1 deletion scripts/bumper/.gitignore

This file was deleted.

14 changes: 0 additions & 14 deletions scripts/bumper/Dockerfile

This file was deleted.

128 changes: 0 additions & 128 deletions scripts/bumper/go.mod

This file was deleted.

0 comments on commit 52646fb

Please sign in to comment.