Skip to content

Commit 0a1de68

Browse files
authored
Add releasing instructions (#78)
1 parent ed44c09 commit 0a1de68

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,26 @@ We're much more likely to approve your changes if you:
144144
* Write a [good commit message][commit-message].
145145
* Maintain backward compatibility.
146146

147+
## Releasing
148+
149+
Releases should be tagged in `x.y.z` SemVer format.
150+
151+
1. Update both [`Connect-Swift.podspec`](../Connect-Swift.podspec) and
152+
[`Connect-Swift-Mocks.podspec`](../Connect-Swift-Mocks.podspec) to reflect
153+
the new version that will be tagged.
154+
2. Create a new GitHub release.
155+
3. Push both specs to CocoaPods:
156+
157+
```sh
158+
pod trunk push Connect-Swift.podspec
159+
pod repo update
160+
pod trunk push Connect-Swift-Mocks.podspec
161+
```
162+
163+
Note: If pushing the mocks podspec fails because CocoaPods cannot find the new
164+
`Connect-Swift` podspec in the specs repo, you may have to wait ~30 min
165+
for it to populate before trying again.
166+
147167
[cla]: https://cla-assistant.io/bufbuild/connect-swift
148168
[commit-message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
149169
[fork]: https://github.com/bufbuild/connect-swift/fork

0 commit comments

Comments
 (0)