Skip to content

Commit f2feb10

Browse files
Merge pull request #185 from timflannagan/remove-scripts-readme
scripts: Update the README.md to point to the downstream gdoc
2 parents e80f052 + 4a81954 commit f2feb10

File tree

1 file changed

+2
-38
lines changed

1 file changed

+2
-38
lines changed

scripts/README.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,5 @@
11
# Syncing downstream OLM
22

3-
All of the staged repositories live in the top level `staging` directory. The versions of each staged dependency are tracked in the [`scripts/tracked`](./tracked) file.
3+
All of the staged repositories live in the top level `staging` directory.
44

5-
## Setup
6-
7-
The sync process requires the git-subtree command. See [git subtree](https://github.com/git/git/blob/master/contrib/subtree/INSTALL) for more detailed instructions.
8-
9-
The local repo also needs to track the upstream remotes in [`scripts/tracked`](./tracked). To add these to your repo, run the `init_remotes` script from the root of your repo:
10-
11-
```bash
12-
./scripts/init_remotes.sh
13-
```
14-
15-
## Syncing with upstream
16-
17-
To sync a staged dependency with an upstream version, you can use the `pull_upstream.sh` helper script. This adds a staged repo if it is not present and updates it to the provided tag/branch otherwise. The script is run as follows:
18-
19-
```bash
20-
./scripts/pull_upstream.sh <remote url or name> [<ref>]
21-
```
22-
23-
The ref can be a valid tag or branch on the remote, and defaults to master. A successful run adds a new commit to the current branch, similar to
24-
25-
```text
26-
1bec1e8bb Sync upstream api v0.6.1
27-
```
28-
29-
Commit history for the staged repositories is not preserved. The latest synced upstream commit for each staged repo can be found in the `./scripts/tracked` file.
30-
31-
Once the sync is completed, verify it by running the unit tests for the dependencies.
32-
33-
## Pushing changes upstream
34-
35-
Changes made to the staged repositories may be pushed upstream by providing specific commit ranges. For this run:
36-
37-
```bash
38-
./scripts/push_upstream.sh <remote name> <commit range or list>
39-
```
40-
41-
This creates a local branch containing from the last synced version of the staged dependency with the specified commits cherry-picked onto it. You can then create a PR from this branch to the required upstream repository.
5+
Note: the process for porting upstream commits downstream is outlined in the [OLM downstreaming guide](https://docs.google.com/document/d/139yXeOqAJbV1ndC7Q4NbaOtzbSdNpcuJan0iemORd3g/edit#).

0 commit comments

Comments
 (0)