Skip to content

Commit 2765998

Browse files
committed
Update downstreaming documentation.
Signed-off-by: Todd Short <[email protected]>
1 parent 57e26f0 commit 2765998

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ above), and then downstreamed to this repository.
1414

1515
Please refer to the [scripts README.md](scripts/README.md) to learn how to
1616
downstream commits from those projects to this repo.
17+
18+
A [TestGrid](https://testgrid.k8s.io/redhat-openshift-olm) is configured for this repository.

scripts/README.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ All of the staged repositories live in the top level `staging` directory.
55
The downstreaming process is complex and helper scripts have been written
66
to facilitate downstreaming.
77

8+
## Automatic Downstreaming
9+
10+
There is now an automated downstreaming process for OLMv0 from the three
11+
source repositories.
12+
13+
The "bumper" program is located in [openshift/operator-framework-tooling](https://github.com/openshift/operator-framework-tooling).
14+
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.
15+
16+
If the bumper program fails to create a mergeable PR, manual intervention will be necessary.
17+
This may require copying, modifying and resubmitting the PR.
18+
819
## Assumptions
920

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

2031
## Bulk Sync
2132

33+
**NOTE**: This should no longer be necessary, given the "bumper" program above.
34+
The "bumper" program can be used instead of the following process.
35+
2236
To sync all current changes from upstream, simply run the sync script:
2337
```sh
2438
scripts/sync.sh
@@ -54,14 +68,18 @@ file in the repositry root directory with the repos and commit SHAs.
5468

5569
The format of the cherrypick file is:
5670
```
57-
<order> <repo> <commit-SHA>
71+
<date-order> <commit-order> <repo> <commit-SHA>
5872
```
5973

74+
* The `<date-order>` field is usually an ISO date without spaces.
75+
* The `<commit-order>` field is a sequential number indicating the order of a commit within a pull request.
76+
* For this _manual_ purpose, both can just be the same sequential number.
77+
6078
For example:
6179
```
62-
1 api 0123456789abcdef0123456789abcdef01234567
63-
2 operator-lifecycle-manager 123456789abcdef0123456789abcdef012345678
64-
3 operator-lifecycle-manager 23456789abcdef0123456789abcdef0123456789
80+
1 1 api 0123456789abcdef0123456789abcdef01234567
81+
2 2 operator-lifecycle-manager 123456789abcdef0123456789abcdef012345678
82+
3 3 operator-lifecycle-manager 23456789abcdef0123456789abcdef0123456789
6583
```
6684
Do _not_ commit the cherrypick file, it is a temporary working file that
6785
is ignored by `git`.

0 commit comments

Comments
 (0)