Skip to content

Commit 499b84f

Browse files
authored
Step description updates (#58)
* Step description updates * updated step description based on review comments
1 parent b77ae26 commit 499b84f

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

step.yml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,27 @@
11
title: Carthage
22
summary: |-
3-
Runs selected Carthage command.
3+
Runs the selected Carthage command.
44
description: |-
5-
Runs selected Carthage command. The step will cache your dependencies only when using `bootstrap` as `carthage_command` and you have `cache-pull` and `cache-push` steps in your workflow.
6-
For more information about Carthage, visit the [Carthage GitHub page](https://github.com/Carthage/Carthage).
5+
Downloads and builds the dependencies your Cocoa application needs.
6+
7+
### Configuring the Step
8+
1. Add the **Carthage** Step in your Workflow.
9+
2. Select `bootstrap` Carthage command in the **Carthage command to run** input. Make sure you have the **Bitrise.io Cache:Pull** Step before and the **Bitrise.io Cache:Push** Step after the **Carthage** Step in your Workflow to cache files and speed up your Bitrise build.
10+
2. Provide your GitHub credentials in the **GitHub Personal Access Token** input to avoid GitHub rate limit issues. Don't worry, your credentials are safe with us since we store them encrypted and do not print them out in build logs.
11+
3. Optionally, you can provide any extra flag for the Carthage command you wish to run in the **Additional options for Carthage command** input.
12+
5. To get more information printed out, set the **Enable verbose logging** to `yes`.
13+
14+
### Troubleshooting
15+
It is important that you use `bootstrap` Carthage command, as this is the only command that can leverage the cache! If you run, for example, the `update` command, it won't generate the required cache information, because the `update` command will disregard the available files or the cache.
16+
17+
### Useful links
18+
- [Official Carthage documentation](https://github.com/Carthage/Carthage)
19+
- [About Secrets and Env Vars ](https://devcenter.bitrise.io/builds/env-vars-secret-env-vars/)
20+
21+
### Related Steps
22+
- [Bitrise.io Cache Push](https://www.bitrise.io/integrations/steps/cache-push)
23+
- [Bitrise.io Cache Pull](https://www.bitrise.io/integrations/steps/cache-pull)
24+
- [iOS Auto Provision](https://www.bitrise.io/integrations/steps/ios-auto-provision)
725
website: https://github.com/bitrise-steplib/steps-carthage
826
source_code_url: https://github.com/bitrise-steplib/steps-carthage
927
support_url: https://github.com/bitrise-steplib/steps-carthage/issues

0 commit comments

Comments
 (0)