Skip to content

NO-ISSUE: scripts: remove legacy bumping implementations #613

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

Merged
merged 1 commit into from
Nov 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 0 additions & 88 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,94 +16,6 @@ It is automatically run on a daily basis based on the following [openshift/relea
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
as follows:
```
git remote add api https://github.com/operator-framework/api
git remote add operator-registry https://github.com/operator-framework/operator-registry
git remote add operator-lifecycle-manager https://github.com/operator-framework/operator-lifecycle-manager
```
The [sync.sh](sync.sh) script will automatically create these
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
```

This script may pause at certain points to ask the user to examine
command failures or possible regressions. Please open another terminal
and review the state of the workspace before continuing the script.

When the script completes, it will have created a branch whose name is
the current date (formatted: `sync-YYYY-MM-DD`).

If the `sync.sh` script fails, please refer to
[[1](https://spaces.redhat.com/display/OOLM/Downstream+to+operator-framework-olm)]
for continuation proceedures.

Before this branch can be used to create a PR, run the following:
```sh
make -k verify
```
If there are any diffs or modified files, these need to be added to
your branch as either a separate commit (e.g. headline: `Run make verify`),
or amended to the last commit of the branch.

Once `make -k verify` is resolved, create a PR from this sync branch.


## Targeted Sync

To sync a subset of commits from the upstream repositories (i.e. critical
bugfix), create a new working sync branch. Then create a `sync.cherrypick`
file in the repositry root directory with the repos and commit SHAs.

The format of the cherrypick file is:
```
<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 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`.

Then run the following:
```sh
scripts/sync_pop_candidate.sh -a sync
```
The commits in the `sync.cherrypick` file will be applied in the specified
order.

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.

Before this branch can be used to create a PR, run the following:
```sh
make -k verify
```
If there are any diffs or modified files, these need to be added to
your branch as either a separate commit (e.g. headline: `Run make verify`),
or amended to the last commit of the branch.

Once `make -k verify` is resolved, create a PR from this working sync branch.

# Long-lived Carry Commits

It is required at times to write commits that will live in the `vendor/` directory
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.

Loading