README.md in sigh-1.0.0.beta6 vs README.md in sigh-1.0.0

- old
+ new

@@ -11,11 +11,16 @@ <a href="https://github.com/KrauseFx/frameit">frameit</a> &bull; <a href="https://github.com/KrauseFx/PEM">PEM</a> &bull; <b>sigh</b> &bull; <a href="https://github.com/KrauseFx/produce">produce</a> &bull; <a href="https://github.com/KrauseFx/cert">cert</a> &bull; - <a href="https://github.com/KrauseFx/codes">codes</a> + <a href="https://github.com/KrauseFx/codes">codes</a> &bull; + <a href="https://github.com/fastlane/spaceship">spaceship</a> &bull; + <a href="https://github.com/fastlane/pilot">pilot</a> &bull; + <a href="https://github.com/fastlane/boarding">boarding</a> &bull; + <a href="https://github.com/fastlane/gym">gym</a> + </p> ------- <p align="center"> <img src="assets/sigh.png"> @@ -32,12 +37,10 @@ `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](https://twitter.com/KrauseFx) -Special thanks to [Matthias Tretter](https://twitter.com/myell0w) for coming up with the name. - ------- <p align="center"> <a href="#features">Features</a> &bull; <a href="#installation">Installation</a> &bull; <a href="#usage">Usage</a> &bull; @@ -49,14 +52,10 @@ ------- <h5 align="center"><code>sigh</code> is part of <a href="https://fastlane.tools">fastlane</a>: connect all deployment tools into one streamlined workflow.</h5> -### spaceship version - -If you're feeling adventurous and want to test the new `sigh` beta with [spaceship](https://spaceship.airforce), update using `sudo gem update sigh --pre`. More information in the [release notes](https://github.com/KrauseFx/sigh/releases/tag/1.0.0.beta5). - # 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 @@ -71,11 +70,11 @@ ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx) ### 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](assets/SignErrors.png)) +- Xcode sometimes invalidates [all existing profiles](assets/SignErrors.png) - 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: @@ -109,36 +108,51 @@ To generate the profile in a specific directory: sigh -o "~/Certificates/" -For a list of available commands run +To download all your provisioning profiles use + sigh download_all + +For a list of available parameters and 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: +To save the provisioning profile under a specific name, use the -q option: - sigh -a com.krausefx.app -u username -f "myProfile.mobileprovision" + sigh -a com.krausefx.app -u username -q "myProfile.mobileprovision" +If for some reason you don't want `sigh` to verify that the code signing identity is installed on your local machine: + + sigh --skip_certificate_verification + 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: +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 +For a list of available parameters and commands run - sigh -d "Nov 11, 2017" + sigh --help +# Repair + +`sigh` can automatically repair all your existing provisioning profiles which are expired or just invalid. + + sigh repair + + # Resign If you generated your `ipa` file but want to apply a different code signing onto the ipa file, you can use `sigh resign`: @@ -163,68 +177,58 @@ Or delete all `iOS Team Provisioning Profile` by using a regular expression sigh manage -p "iOS\ ?Team Provisioning Profile:" ## Environment Variables -In case you prefer environment variables: -- `SIGH_USERNAME` -- `SIGH_APP_IDENTIFIER` (The App's Bundle ID , e.g. `com.yourteam.awesomeapp`) -- `SIGH_TEAM_ID` (The Team ID, e.g. `Q2CBPK58CA`) -- `SIGH_PROVISIONING_PROFILE_NAME` (set a custom name for the name of the generated file) +Run `sigh --help` to get a list of all available environment variables. -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) - -As always, run `sigh --help` to get a list of all variables. - If you're using [cert](https://github.com/KrauseFx/cert) in combination with [fastlane](https://github.com/KrauseFx/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](https://github.com/KrauseFx/sigh/blob/master/lib/sigh/developer_center.rb). +`sigh` will access the `iOS Dev Center` to download, renew or generate the `.mobileprovision` file. It uses [spaceship](https://spaceship.airforce) to communicate with Apple's web services. ## How is my password stored? -```sigh``` uses the [password manager](https://github.com/KrauseFx/CredentialsManager) from `fastlane`. Take a look the [CredentialsManager README](https://github.com/KrauseFx/CredentialsManager) for more information. +`sigh` uses the [CredentialsManager](https://github.com/fastlane/CredentialsManager) from `fastlane`. # Tips ## [`fastlane`](https://fastlane.tools) Toolchain - [`fastlane`](https://fastlane.tools): Connect all deployment tools into one streamlined workflow -- [`deliver`](https://github.com/KrauseFx/deliver): Upload screenshots, metadata and your app to the App Store using a single command +- [`deliver`](https://github.com/KrauseFx/deliver): Upload screenshots, metadata and your app to the App Store - [`snapshot`](https://github.com/KrauseFx/snapshot): Automate taking localized screenshots of your iOS app on every device - [`frameit`](https://github.com/KrauseFx/frameit): Quickly put your screenshots into the right device frames - [`PEM`](https://github.com/KrauseFx/pem): Automatically generate and renew your push notification profiles - [`produce`](https://github.com/KrauseFx/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line - [`cert`](https://github.com/KrauseFx/cert): Automatically create and maintain iOS code signing certificates - [`codes`](https://github.com/KrauseFx/codes): Create promo codes for iOS Apps using the command line +- [`spaceship`](https://github.com/fastlane/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect +- [`pilot`](https://github.com/fastlane/pilot): The best way to manage your TestFlight testers and builds from your terminal +- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers +- [`gym`](https://github.com/fastlane/gym): Building your iOS apps has never been easier + ##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx) ## Use the 'Provisioning Quicklook plugin' Download and install the [Provisioning Plugin](https://github.com/chockenberry/Provisioning). -It will show you the ```mobileprovision``` files like this: +It will show you the `mobileprovision` files like this: ![assets/QuickLookScreenshot.png](assets/QuickLookScreenshot.png) +## App Identifier couldn't be found +If you also want to create a new App Identifier on the Apple Developer Portal, check out [produce](https://github.com/fastlane/produce), which does exactly that. + +## What happens to my Xcode managed profiles? + +`sigh` will never touch or use the profiles which are created and managed by Xcode. Instead `sigh` will manage its own set of provisioning profiles. + # Need help? -- If there is a technical problem with ```sigh```, submit an issue. -- I'm available for contract work - drop me an email: sigh@krausefx.com +Please submit an issue on GitHub and provide information about your setup # 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 +> This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.