|
| 1 | +# Introduction |
| 2 | + |
| 3 | +This is a quick guide on how to deploy the Cely Swift Framework. You will need to have [cocoapods](https://cocoapods.org/) installed along with being registered with [trunk](https://guides.cocoapods.org/making/getting-setup-with-trunk.html) and having permissions to deploy new versions of Cely. |
| 4 | + |
| 5 | +# Bumping Version |
| 6 | + |
| 7 | +Bumping a version should happen on its own pull request(commit) separate from any features or bug fixes, unless these fixes are for making the Cely framework compatible with newer versions of Swift or Xcode. I.E. a pull request to make Cely Swift 5 compatible. |
| 8 | + |
| 9 | +Here is a checklist of files that will need to be updated when releasing a new version: |
| 10 | + |
| 11 | +#### README.md |
| 12 | + |
| 13 | +>To integrate Cely into your Xcode project using CocoaPods, specify it in your Podfile: |
| 14 | +``` |
| 15 | +source 'https://github.com/CocoaPods/Specs.git' |
| 16 | +platform :ios, '8.0' |
| 17 | +use_frameworks! |
| 18 | +
|
| 19 | +pod 'Cely', '~> <NEW_VERSION>' |
| 20 | +``` |
| 21 | + |
| 22 | +... |
| 23 | + |
| 24 | +>To integrate Cely into your Xcode project using Carthage, specify it in your Cartfile: |
| 25 | +``` |
| 26 | +github "initFabian/Cely" ~> <NEW_VERSION> |
| 27 | +``` |
| 28 | + |
| 29 | +#### `Cely.podspec` |
| 30 | + |
| 31 | +```ruby |
| 32 | +Pod::Spec.new do |spec| |
| 33 | + spec.swift_version = '4.2' # new swift version |
| 34 | + spec.name = 'Cely' |
| 35 | + spec.version = '<NEW_VERSION>' |
| 36 | +``` |
| 37 | + |
| 38 | + |
| 39 | +#### `.swift-version` |
| 40 | + |
| 41 | +if we are updating to a new Swift version, please update this file. |
| 42 | + |
| 43 | + |
| 44 | +# Deploy |
| 45 | + |
| 46 | +## Tagging |
| 47 | + |
| 48 | +Once the pull request containing the changes for the version bump is merged in, tag a new version on Github. For consistency purposes, please use the format, `X.X.X`, ~~**NOT `vX.X.X`**~~. |
| 49 | + |
| 50 | +## Carthage |
| 51 | + |
| 52 | +Since carthage uses Github's tagging system, no additional work other than tagging a release is necessary. |
| 53 | + |
| 54 | +## Cocoapods |
| 55 | + |
| 56 | +Cocoapods uses its own repository to store new releases(`podspec`) of Frameworks. It uses its command-line tool [trunk](https://blog.cocoapods.org/CocoaPods-Trunk/) to handle deploying. If you would like to get started with trunk, please checkout this [getting started article](https://guides.cocoapods.org/making/getting-setup-with-trunk.html). |
| 57 | + |
| 58 | +Before deploying, run cocoapods linting tool to quickly verify you have no mistakes in your `podspec` file. Trunk will still eventually run this command before pushing up a new version, but running it separately will yield quicker results. |
| 59 | + |
| 60 | +In the root directory of the Cely project, run the following: |
| 61 | +```sh |
| 62 | +$ pod spec lint Cely.podspec |
| 63 | +``` |
| 64 | + |
| 65 | +example error: |
| 66 | + |
| 67 | +```sh |
| 68 | +-> Cely.podspec |
| 69 | + - ERROR | spec: The specification defined in `Cely.podspec` could not be loaded. |
| 70 | + |
| 71 | + |
| 72 | +[!] Invalid `Cely.podspec` file: undefined method `nafme=' for #<Pod::Specification name=nil> |
| 73 | +Did you mean? name= |
| 74 | + name. |
| 75 | +
|
| 76 | + # from /Users/fabianBuentello/Development/iOS/Cely/Cely.podspec:3 |
| 77 | + # ------------------------------------------- |
| 78 | + # spec.swift_version = '4.2' |
| 79 | + > spec.nafme = 'Cely' |
| 80 | + # spec.version = '2.1.0' |
| 81 | + # ------------------------------------------- |
| 82 | +
|
| 83 | +
|
| 84 | +Analyzed 1 podspec. |
| 85 | +``` |
| 86 | +
|
| 87 | +If the linting succeeds, then in order to deploy run the following command: |
| 88 | +
|
| 89 | +``` |
| 90 | +pod trunk push Cely.podspec |
| 91 | +``` |
| 92 | +
|
| 93 | +
|
| 94 | +### Cocoapods troubleshooting |
| 95 | +
|
| 96 | +If your trunk session is expired, you will be asked to reauthenticate. You will run the command below. Afterwards, you will receive an email from `[email protected]` with a link to confirm your session. Click on the link and you should be good to go. |
| 97 | +
|
| 98 | +```sh |
| 99 | +$ pod trunk register <email> |
| 100 | +``` |
| 101 | +
|
| 102 | +If you are not sure if your session has expired, you can run the following command: |
| 103 | +
|
| 104 | +```sh |
| 105 | +$ pod trunk me |
| 106 | +``` |
| 107 | +
|
| 108 | +**Fail on warnings** |
| 109 | +
|
| 110 | +Depending on your version of cocoapods, it may not recognize the property `swift_version` inside of `Cely.podspec`. As mentioned in issue [\#8635](https://github.com/CocoaPods/CocoaPods/issues/8635), a workaround for this is to append the `--allow-warnings` flag when pushing. This issue should be getting resolved with cocoapods v1.7. |
| 111 | +
|
| 112 | +```sh |
| 113 | +$ pod trunk push Cely.podspec --allow-warnings |
| 114 | +``` |
| 115 | +
|
| 116 | +--- |
| 117 | +
|
| 118 | +Here are the `--help` options: |
| 119 | +
|
| 120 | +```sh |
| 121 | +$ pod trunk --help |
| 122 | +Usage: |
| 123 | +
|
| 124 | + $ pod trunk COMMAND |
| 125 | +
|
| 126 | + Interact with the CocoaPods API (e.g. publishing new specs) |
| 127 | +
|
| 128 | +Commands: |
| 129 | +
|
| 130 | + + add-owner Add an owner to a pod |
| 131 | + + delete Deletes a version of a pod. |
| 132 | + + deprecate Deprecates a pod. |
| 133 | + + info Returns information about a Pod. |
| 134 | + + me Display information about your sessions |
| 135 | + + push Publish a podspec |
| 136 | + + register Manage sessions |
| 137 | + + remove-owner Remove an owner from a pod |
| 138 | +
|
| 139 | +Options: |
| 140 | +
|
| 141 | + --silent Show nothing |
| 142 | + --verbose Show more debugging information |
| 143 | + --no-ansi Show output without ANSI codes |
| 144 | + --help Show help banner of specified command |
| 145 | +``` |
0 commit comments