Skip to content

Commit

Permalink
Update releasing instructions (#383)
Browse files Browse the repository at this point in the history
Update the instructions to include step-by-step, as well as mentioning Carthage project re-generation.
  • Loading branch information
rebello95 authored Feb 28, 2019
1 parent ba335b2 commit f5c0d63
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,11 +170,20 @@ Please get involved! See our [guidelines for contributing](CONTRIBUTING.md).

### Releasing

Prior to creating a new release tag for SwiftGRPC, the `.podspec` file's version should be bumped, and the
CocoaPods spec linter should be run to ensure that there are no new warnings/errors:
When issuing a new release, the following steps should be followed:

$ pod spec lint SwiftGRPC.podspec
1. Run the CocoaPods linter to ensure that there are no new warnings/errors:

Once a new release tag is created, the updated CocoaPods spec should also be pushed to the master specs repo:
`$ pod spec lint SwiftGRPC.podspec`

1. Update the Carthage Xcode project (diff will need to be checked in with the version bump):

$ pod trunk push SwiftGRPC.podspec
`$ make project-carthage`

1. Bump the version in the `SwiftGRPC.podspec` file

1. Merge these changes, then create a new `Release` with corresponding `Tag`. Be sure to include a list of changes in the message

1. Push the update to the CocoaPods specs repo:

`$ pod trunk push`

0 comments on commit f5c0d63

Please sign in to comment.