[Dev doc] Add Carthage version #1578
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nguyenhuy
requested changes
Jul 10, 2019
| @@ -11,5 +11,5 @@ Setting up your dev environment: | |||
| - Clone the framework's source code to your machine: `git clone [email protected]:TextureGroup/Texture.git` or `git clone https://github.com/TextureGroup/Texture.git`. | |||
| - Run `pod install` in the directory that you cloned to. | |||
| - Open "AsyncDisplayKit.xcworkspace" file CocoaPods has just generated. The workspace includes all the source code, as well as our test suite. | |||
| - Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode version and Cocoapods version as the CI (currently Xcode 10.2.1 and Cocoapods 1.6). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. | |||
| - Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode version and Cocoapods version as the CI (currently Xcode 10.2.1, Cocoapods 1.6 and Carthage 0.33.0). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. | |||
There was a problem hiding this comment.
Given that this sentence is about our CI setup which doesn't use Carthage, I wonder if we should instead mention it in the last sentence?
Suggested change
| - Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode version and Cocoapods version as the CI (currently Xcode 10.2.1, Cocoapods 1.6 and Carthage 0.33.0). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. | |
| - Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode version and Cocoapods version as the CI (currently Xcode 10.2.1 and Cocoapods 1.6). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need Carthage 0.33.0 and the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. |
There was a problem hiding this comment.
On a second thought, the CI has Carthage installed too.
Suggested change
| - Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode version and Cocoapods version as the CI (currently Xcode 10.2.1, Cocoapods 1.6 and Carthage 0.33.0). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. | |
| - Run `./build.sh all` locally and ensure all tests pass. Also make sure you're running the same Xcode, Cocoapods and Carthage versions as the CI (currently Xcode 10.2.1, Cocoapods 1.6 and Carthage 0.33.0). [xcversion](https://github.com/xcpretty/xcode-install) is a handy tool for keeping multiple versions of Xcode installed. You'll also need the correct [simulator device configuration](https://github.com/TextureGroup/Texture/blob/32a2ebf49b797b0ba2a74f2af44457a9aa7b1160/build.sh#L3) available. |
hanton
force-pushed
the
doc-add-carthage-version
branch
from
7feea03
to
1a0de2e
Compare
|
hi @nguyenhuy , thanks for the suggestion, I've updated the PR :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Carthage version
0.33.0to theHow to start contributing to Texturedoc, or run./build.sh carthagewill fail withbecause of this Carthage Issue.