Skip to content

Commit ecdbb8b

Browse files
authored
Merge pull request apple#674 from thomasvl/notes
Document the `.swift-version` file warning and working around it.
2 parents 1dacc00 + a59ae8b commit ecdbb8b

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Documentation/RELEASING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,16 @@ When doing a release:
5050
5151
1. Publish the CocoaPod
5252
53+
_Note:_ The `pod` binary is currently pushing the use of the `.swift-version` file to control
54+
how a spec is checked for `spec lint` and `trunk push`. But the file isn't well documented and
55+
there has been some questions around that net that seem to imply people interpret this as the
56+
"version of Swift the pod supports". Since SwiftProtobuf supports multiple versions, a
57+
`.swift-version` file currently isn't included. So you want the `spec lint` to pass with only
58+
the warning about the file. And when doing the `trunk push` you'll want to include
59+
`--allow-warnings` to let the push happen despite the warning. Even if you use
60+
`--swift-version=#` to either commend, the `pod` binary still produces the warning, so it
61+
doesn't work to avoid the warning.
62+
5363
1. Do a final sanity check that CocoaPods is happy with the release you just made, in the project
5464
directory:
5565
@@ -70,11 +80,14 @@ When doing a release:
7080
1. Publish the pod:
7181
7282
```
73-
$ pod trunk push SwiftProtobuf.podspec
83+
$ pod trunk push [--allow-warnings] SwiftProtobuf.podspec
7484
```
7585
7686
_Note:_ This uses that local copy of the podspec.
7787
88+
See the _Note_ at the start of this section about `.swift-version` and why you might
89+
need `--allow-warnings`.
90+
7891
1. Bump the version on _master_
7992
8093
To help tell if someone is using _master_ before it has been cut as a release, go ahead and

0 commit comments

Comments
 (0)