fastlane

deliver • snapshot • frameit • pem • sigh • produce • cert • spaceship • pilot • boarding • gym • scan • match • precheck

---

Precheck

Check your app using a community driven set of App Store review rules to avoid being rejected

Apple rejects builds for many avoidable metadata issues like including swear words 😮, other companies’ trademarks, or even mentioning an iOS bug 🐛. fastlane precheck takes a lot of the guess work out by scanning your app’s details in iTunes Connect for avoidable problems. fastlane precheck helps you get your app through app review without rejections so you can ship faster 🚀

Get in contact with the developers on Twitter: @FastlaneTools

---

Features • Quick Start • Usage • Example • How does it work? • Tips • Need help?

---

precheck is part of fastlane: The easiest way to automate beta deployments and releases for your iOS and Android apps.

Features

	precheck Features
🐛	 product bug mentions
🙅‍♂️	Swear word checker
🤖	Mentioning other platforms
😵	URL reachability checker
📝	Placeholder/test words/mentioning future features
📅	Copyright date checking
🙈	Customizable word list checking
📢	You can decide if you want to warn about potential problems and continue or have fastlane show an error and stop after all scans are done.

Do you like fastlane? Be the first to know about updates and new fastlane tools

Quick Start

sudo gem install fastlane

Usage

Run fastlane precheck to check the app metadata from iTunes Connect

fastlane precheck

To get a list of available options run

fastlane precheck --help

Example

Since you might want to manually trigger precheck but don't want to specify all the parameters every time, you can store your defaults in a so called Precheckfile.

Run fastlane precheck init to create a new configuration file. Example:

# indicates that your metadata will not be checked by this rule
negative_apple_sentiment(level: :skip)

# when triggered, this rule will warn you of a potential problem
curse_words(level: :warn)

# show error and prevent any further commands from running after fastlane precheck finishes
unreachable_urls(level: :error)

# pass in whatever words you want to check for
custom_text(data: ["chrome", "webos"], 
           level: :warn)

Use with fastlane

precheck is fully integrated with deliver another fastlane tool.

Update your Fastfile to contain the following code:

lane :production do
  ...
  # by default deliver will call precheck and warn you of any problems
  # if you want precheck to halt submitting to app review, you can pass
  # precheck_default_rule_level: :error
  deliver(precheck_default_rule_level: :error)
  ...
end

# or if you prefer, you can run precheck alone
lane :check_metadata do
  precheck
end

How does it work?

precheck will access iTunes Connect to download your app's metadata. It uses spaceship to communicate with Apple's web services.

Tips

fastlane Toolchain

• fastlane: The easiest way to automate beta deployments and releases for your iOS and Android apps
• deliver: Upload screenshots, metadata and your app to the App Store
• 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
• sigh: Because you would rather spend your time building stuff than fighting provisioning
• produce: Create new iOS apps on iTunes Connect and Dev Portal using the command line
• cert: Automatically create and maintain iOS code signing certificates
• spaceship: Ruby library to access the Apple Dev Center and iTunes Connect
• pilot: The best way to manage your TestFlight testers and builds from your terminal
• boarding: The easiest way to invite your TestFlight beta testers
• gym: Building your iOS apps has never been easier
• scan: The easiest way to run tests of your iOS and Mac app
• match: Easily sync your certificates and profiles across your team using git

Do you like fastlane? Be the first to know about updates and new fastlane tools

Need help?

Please submit an issue on GitHub and provide information about your setup

Want to improve precheck's rules?

Please submit an issue on GitHub and provide information about your App Store rejection! Make sure you scrub out any personally identifiable information since this will be public.

Code of Conduct

Help us keep precheck open and inclusive. Please read and follow our Code of Conduct.

License

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

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.