Skip to content

Latest commit

 

History

History
209 lines (137 loc) · 8.32 KB

README.md

File metadata and controls

209 lines (137 loc) · 8.32 KB
Raw


fastlane

deliver • snapshot • frameit • PEM • sigh • produce • cert • codes

-------

sigh

Twitter: @KauseFx License Gem

Because you would rather spend your time building stuff than fighting provisioning

sigh can create, renew, download and repair provisioning profiles (with one command). It supports App Store, Ad Hoc, Development and Enterprise profiles and supports nice features, like auto-adding all test devices.

Get in contact with the developer on Twitter: @KrauseFx

Features • Installation • Usage • Resign • How does it work? • Tips • Need help?

sigh is part of fastlane: connect all deployment tools into one streamlined workflow.

Features

  • Download the latest provisioning profile for your app
  • Renew a provisioning profile, when it has expired
  • Repair a provisioning profile, when it is broken
  • Create a new provisioning profile, if it doesn't exist already
  • Supports App Store, Ad Hoc and Development profiles
  • Support for multiple Apple accounts, storing your credentials securely in the Keychain
  • Support for multiple Teams
  • Support for Enterprise Profiles

To automate iOS Push profiles you can use PEM.

Like this tool? Be the first to know about updates and new fastlane tools

Why not let Xcode do the work?

  • sigh can easily be integrated into your CI-server (e.g. Jenkins)
  • Xcode sometimes invalidates all existing profiles (Screenshot)
  • You have control over what happens
  • You still get to have the signing files, which you can then use for your build scripts or store in git

See sigh in action:

assets/sighRecording.gif

Installation

sudo gem install sigh

Make sure, you have the latest version of the Xcode command line tools installed:

xcode-select --install

Usage

sigh

Yes, that's the whole command!

sigh will create, repair and download profiles for the App Store by default.

You can pass your bundle identifier and username like this:

sigh -a com.krausefx.app -u username

If you want to generate an Ad Hoc profile instead of an App Store profile:

sigh --adhoc

If you want to generate a Development profile:

sigh --development

To generate the profile in a specific directory:

sigh -o "~/Certificates/"

For a list of available commands run

sigh --help

Advanced

By default, sigh will install the downloaded profile on your machine. If you just want to generate the profile and skip the installation, use the following flag:

sigh --skip_install

To save the provisioning profile under a specific name, use the -f option:

sigh -a com.krausefx.app -u username -f "myProfile.mobileprovision"

If you need the provisioning profile to be renewed regardless of its state use the --force option. This gives you a profile with the maximum lifetime. --force will also add all available devices to this profile.

sigh --force

By default, sigh will include all certificates on development profiles, and first certificate on other types. If you need to specify which certificate to use you can either use the environment variable SIGH_CERTIFICATE, or pass the name or expiry date of the certificate as argument:

sigh -c "SunApps GmbH"

Or identify be expire date if you're using the same names for multiple certificates

sigh -d "Nov 11, 2017"

Resign

If you generated your ipa file but want to apply a different code signing onto the ipa file, you can use sigh resign:

sigh resign

sigh will find the ipa file and the provisioning profile for you if they are located in the current folder.

You can pass more information using the command line:

sigh resign ./path/app.ipa -i "iPhone Distribution: Felix Krause" -p "my.mobileprovision"

Environment Variables

In case you prefer environment variables:

  • SIGH_USERNAME
  • SIGH_APP_IDENTIFIER
  • SIGH_TEAM_ID (The Team ID, e.g. Q2CBPK58CA)
  • SIGH_PROVISIONING_PROFILE_NAME (set a custom name for the name of the generated file)

Choose signing certificate to use:

  • SIGH_CERTIFICATE (The name of the certificate to use)
  • SIGH_CERTIFICATE_ID (The ID of the certificate)
  • SIGH_CERTIFICATE_EXPIRE_DATE (The expire date of the certificate)

If you're using cert in combination with fastlane the signing certificate will automatically be selected for you. (make sure to run cert before sigh)

sigh will store the UDID of the generated provisioning profile in the environment: SIGH_UDID.

How does it work?

sigh will access the iOS Dev Center to download, renew or generate the .mobileprovision file. Check out the full source code: developer_center.rb.

How is my password stored?

sigh uses the password manager from fastlane. Take a look the CredentialsManager README for more information.

Tips

fastlane Toolchain

  • fastlane: Connect all deployment tools into one streamlined workflow
  • deliver: Upload screenshots, metadata and your app to the App Store using a single command
  • snapshot: Automate taking localized screenshots of your iOS app on every device
  • frameit: Quickly put your screenshots into the right device frames
  • PEM: Automatically generate and renew your push notification profiles
  • produce: Create new iOS apps on iTunes Connect and Dev Portal using the command line
  • cert: Automatically create and maintain iOS code signing certificates
  • codes: Create promo codes for iOS Apps using the command line
Like this tool? Be the first to know about updates and new fastlane tools

Use the 'Provisioning Quicklook plugin'

Download and install the Provisioning Plugin.

It will show you the mobileprovision files like this: assets/QuickLookScreenshot.png

Need help?

  • If there is a technical problem with sigh, submit an issue.
  • I'm available for contract work - drop me an email: [email protected]

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

Contributing

  1. Create an issue to start a discussion about your idea
  2. Fork it (https://github.com/KrauseFx/sigh/fork)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request