Skip to content

Commit 450d463

Browse files
authored
Zip Builder README fixes (#7200)
1 parent 5502a08 commit 450d463

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

ReleaseTooling/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ In order to build the Zip file, you will need:
2121

2222
### Running the Tool
2323

24-
You can run the tool with `swift run zip-builder [ARGS]` or generate an Xcode project with
25-
`swift package generate-xcodeproj` and run within Xcode.
24+
You can run the tool with `swift run zip-builder [ARGS]` or `open Package.swift` to debug or run
25+
within Xcode.
2626

27-
Since Apple does not support linking libraries built by future Xcode versions, make sure to builid with the
27+
Since Apple does not support linking libraries built by future Xcode versions, make sure to build with the
2828
earliest Xcode needed by any of the library clients. The Xcode command line tools must also be configured
2929
for that version. Check with `xcodebuild -version`.
3030

@@ -69,7 +69,12 @@ Optional common arguments:
6969
- `--no-update-pod-repo`
7070
- This is for speedups when `pod repo update` has already been run recently.
7171

72-
For release engineers (Googlers packaging an upcoming Firebase release) these commands should also be used:
72+
### Firebase Release zip building
73+
74+
If the `--zip-pods` option is not specified, the tool will build a Firebase zip distribution.
75+
76+
For release engineers (Googlers packaging an upcoming Firebase release) these commands should also
77+
be used:
7378
- `--custom-spec-repos sso://cpdc-internal/firebase`
7479
- This pulls the latest podspecs from the CocoaPods staging area.
7580
- `--repo-dir path` GitHub repo containing Template and Carthage json file inputs.
@@ -86,7 +91,7 @@ swift run zip-builder --update-pod-repo \
8691
--keep-build-artifacts
8792
```
8893

89-
### Carthage
94+
#### Carthage
9095

9196
Carthage binaries can also be built at the same time as the zip file by passing in `--enable-carthage-build`
9297
as a command line argument. This directory should contain JSON files describing versions and download

0 commit comments

Comments
 (0)