You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,6 +145,33 @@ Some exceptions to this rule exist for cases in which we absolutely must deploy
145
145
If you're changing or adding a contract and you're unsure about which branch to make a PR into, default to using a feature branch.
146
146
Feature branches are typically used when there are conflicts between 2 projects touching the same code, to avoid conflicts from merging both into `develop`.
147
147
148
+
## Downloading & Shallow-Cloning the Monorepo
149
+
150
+
If you want to use the monorepo as a dependency, e.g. in CI, you can greatly speed up the fetching process by either downloading it directly as an archive from Github instead of cloning as a git repository or shallow-cloning it.
151
+
This avoids downloading the full monorepo git history, which is unfortunately a few GBs in size, but which also isn't needed for many use cases, like CI.
152
+
153
+
To fetch the monorepo at a specific commit/branch/tag `$REF`, download and unpack with
154
+
```
155
+
curl -L https://github.com/ethereum-optimism/optimism/archive/$REF.tar.gz | tar xz
156
+
```
157
+
Note that if you need any of its submodules, you'd need to manually download those too.
158
+
159
+
If you want a shallow git clone of latest `develop`, you can just do
All other files within this repository are licensed under the [MIT License](https://github.com/ethereum-optimism/optimism/blob/master/LICENSE) unless stated otherwise.
0 commit comments