https://github.com/bitrise-steplib/steps-certificate-and-profile-installer
steps-certificate-and-profile-installer
https://github.com/bitrise-steplib/steps-certificate-and-profile-installer
bitrise bitrise-step ci hacktoberfest production-code
Last synced: 6 months ago
JSON representation
steps-certificate-and-profile-installer
- Host: GitHub
- URL: https://github.com/bitrise-steplib/steps-certificate-and-profile-installer
- Owner: bitrise-steplib
- License: mit
- Created: 2015-07-30T22:04:44.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-18T02:00:27.000Z (10 months ago)
- Last Synced: 2025-03-24T07:50:20.392Z (7 months ago)
- Topics: bitrise, bitrise-step, ci, hacktoberfest, production-code
- Language: Go
- Homepage:
- Size: 1010 KB
- Stars: 13
- Watchers: 14
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Certificate and profile installer
[](https://github.com/bitrise-steplib/steps-certificate-and-profile-installer/releases)
Downloads and installs the Apple code signing certificates and provisioning profiles.
Description
The Step installs those .p12 certificate files and provisioning profiles that you uploaded to your app's **Code Signing** tab. You can upload multiple versions of any code signing file.
### Configuring the Step
By default, the Step requires no configuration. To be able to use it, you only need to upload a .p12 certificate and a matching provisioning profile to the **Code signing** tab.
However, if your certificates have passphrases, you need to make sure that passphrase is available for the Step.
1. Create a [Secret Env Var](https://devcenter.bitrise.io/builds/env-vars-secret-env-vars/) that contains the passphrase.
1. Insert that Secret to the **Certificate passphrase** input.
Similarly, you can set the path to the Keychain that should be used in the **Keychain path** input, and set a password for the Keychain in the **Keychain's password** input.
### Troubleshooting
In the case of most code signing issues, it's the **Xcode Archive & Export for iOS** Step that fails, not this one. If this Step fails, there's a couple of things you can do first.
- Check the certificate passphrase, the Keychain path and the Keychain password.
- Make sure you uploaded the required code signing files.
### Useful links
- [iOS code signing](https://devcenter.bitrise.io/code-signing/ios-code-signing/code-signing-index/)
- [iOS deployment](https://devcenter.bitrise.io/deploy/ios-deploy/ios-deploy-index/)
### Related Steps
- [iOS Auto Provision](https://www.bitrise.io/integrations/steps/ios-auto-provision)
- [Xcode Archive & Export for iOS](https://www.bitrise.io/integrations/steps/xcode-archive)
- [Deploy to iTunesConnect](https://www.bitrise.io/integrations/steps/deploy-to-itunesconnect-deliver)
## 🧩 Get started
Add this step directly to your workflow in the [Bitrise Workflow Editor](https://devcenter.bitrise.io/steps-and-workflows/steps-and-workflows-index/).
You can also run this step directly with [Bitrise CLI](https://github.com/bitrise-io/bitrise).
## ⚙️ Configuration
Inputs
| Key | Description | Flags | Default |
| --- | --- | --- | --- |
| `certificate_url` | URL of the certificate to download. Multiple URLs can be specified, separated by a pipe (`\|`) character. You can specify a local path as well, using the `file://` scheme. For example `file://./Cert.p12` | sensitive | `$BITRISE_CERTIFICATE_URL` |
| `certificate_passphrase` | Certificate passphrase. Multiple passphrases can be specified, separated by a pipe character (`\|`). Specified Certificate passphrase count should match the count of the certificate urls. Pipe characters in passphrases are not supported. Format example: - 1 certificate provided with passphrase: `PASS` - 1 certificate provided without passphrase: `` - 3 certificates provided, none of them has passphrase: `\|\|` - 3 certificates provided, only the 2. one has passphrase: `\|PASS\|` | sensitive | `$BITRISE_CERTIFICATE_PASSPHRASE` |
| `provisioning_profile_url` | URL of the provisioning profile to download. Multiple URLs can be specified, separated by a pipe (`\|`) character. You can specify a local path as well, using the `file://` scheme. For example `file://./BuildAnything.mobileprovision` | sensitive | `$BITRISE_PROVISION_URL` |
| `keychain_path` | Path to the Keychain where the code signing certificates will be installed. | required | `$HOME/Library/Keychains/login.keychain` |
| `keychain_password` | Password for the provided Keychain. | required, sensitive | `$BITRISE_KEYCHAIN_PASSWORD` |
| `install_defaults` | Installs default (Bitrise) Wildcard Provisioning Profile and Codesign Certificate for testing. | | `yes` |
| `default_certificate_url` | URL of the default certificate. You can specify a local path as well, using the `file://` scheme. For example `file://./Cert.p12` | sensitive | `$BITRISE_DEFAULT_CERTIFICATE_URL` |
| `default_certificate_passphrase` | Passphrase of the default Certificate. | sensitive | `$BITRISE_DEFAULT_CERTIFICATE_PASSPHRASE` |
| `default_provisioning_profile_url` | URL of the default provisioning profile to download. You can specify a local path as well, using the `file://` scheme. For example `file://./BuildAnything.mobileprovision` | sensitive | `$BITRISE_DEFAULT_PROVISION_URL` |
| `verbose` | Enable logging additional information for troubleshooting | required | `false` |
Outputs
There are no outputs defined in this step
## 🙋 Contributing
We welcome [pull requests](https://github.com/bitrise-steplib/steps-certificate-and-profile-installer/pulls) and [issues](https://github.com/bitrise-steplib/steps-certificate-and-profile-installer/issues) against this repository.
For pull requests, work on your changes in a forked repository and use the Bitrise CLI to [run step tests locally](https://devcenter.bitrise.io/bitrise-cli/run-your-first-build/).
**Note:** this step's end-to-end tests (defined in `e2e/bitrise.yml`) are working with secrets which are intentionally not stored in this repo. External contributors won't be able to run those tests. Don't worry, if you open a PR with your contribution, we will help with running tests and make sure that they pass.
Learn more about developing steps:
- [Create your own step](https://devcenter.bitrise.io/contributors/create-your-own-step/)
- [Testing your Step](https://devcenter.bitrise.io/contributors/testing-and-versioning-your-steps/)