steps-carthage/step.yml at master · bitrise-steplib/steps-carthage · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
title: Carthage
summary: |-
  Runs the selected Carthage command.
description: |-
  Downloads and builds the dependencies your Cocoa application needs.

  ### Configuring the Step
  1. Add the **Carthage** Step in your Workflow.
  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.
  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.
  3. Optionally, you can provide any extra flag for the Carthage command you wish to run in the **Additional options for Carthage command** input.
  5. To get more information printed out, set the **Enable verbose logging** to `yes`.

  ### Troubleshooting
  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.

  ### Useful links
  - [Official Carthage documentation](https://github.com/Carthage/Carthage)
  - [About Secrets and Env Vars ](https://devcenter.bitrise.io/builds/env-vars-secret-env-vars/)

  ### Related Steps
  - [Bitrise.io Cache Push](https://www.bitrise.io/integrations/steps/cache-push)
  - [Bitrise.io Cache Pull](https://www.bitrise.io/integrations/steps/cache-pull)
  - [iOS Auto Provision](https://www.bitrise.io/integrations/steps/ios-auto-provision)
website: https://github.com/bitrise-steplib/steps-carthage
source_code_url: https://github.com/bitrise-steplib/steps-carthage
support_url: https://github.com/bitrise-steplib/steps-carthage/issues
host_os_tags:
- osx-10.10
project_type_tags:
- cordova
- flutter
- ionic
- ios
- kotlin-multiplatform
- macos
- react-native
type_tags:
- dependency
is_requires_admin_user: false
is_always_run: false
is_skippable: false
deps:
  brew:
  - name: carthage
toolkit:
  go:
    package_name: github.com/bitrise-steplib/steps-carthage
inputs:
- carthage_command: bootstrap
  opts:
    title: Carthage command to run
    summary: Select a command to set up your dependencies. The step will cache your dependencies only when using `bootstrap` in this input and you have `cache-pull` and `cache-push` steps in your workflow.
    description: |-
      Select a command to set up your dependencies.

      The step will cache your dependencies only when using `bootstrap` in this input and you have `cache-pull` and `cache-push` steps in your workflow.

      To see available commands run: `carthage help` on your local machine.
    is_required: true
- carthage_options:
  opts:
    title: Additional options for `carthage` command
    description: |-
      Options added to the end of the Carthage call.
      You can use multiple options, separated by a space character.

      To see available command's options, call `carthage help COMMAND`

      Format example: `--platform ios`
- github_access_token: $GITHUB_ACCESS_TOKEN
  opts:
    title: Github Personal Access Token
    description: |-
      Use this input to avoid Github rate limit issues.

      See the github's guide: [Creating an access token for command-line use](https://help.github.com/articles/creating-an-access-token-for-command-line-use/),
      how to create Personal Access Token.

      __UNCHECK EVERY SCOPE BOX__ when creating this token. There is no reason this token needs access to private information.
    is_sensitive: true
- xcconfig:
  opts:
    title: Custom xcconfig file to add to Carthage environment
    description: |-
      Use this input to provide an `xcconfig` file as a workaround for the Xcode 12 issue. For more information, see [the Github issue](https://github.com/Carthage/Carthage/issues/3019).

      Can either be a local file provided with the `file://` scheme (like `file://path/to/file.xcconfig`) or an URL (like https://domain.com/file.xconfig).
- verbose_log: "no"
  opts:
    category: Debug
    title: Enable verbose logging?
    description: Enable verbose logging?
    is_required: true
    value_options:
    - "yes"
    - "no"