Continuous Integration

Some people have been asking for ways to run Faux Pas on their continuous integration (CI) servers. Here are some instructions on how to set this up.

Installing Faux Pas on CI Servers

First you need to install Faux Pas onto your CI server:

1. Install the app onto the server:
   • Via Homebrew Cask: brew cask install fauxpas, or:
   • By copying the .app bundle there from your local workstation (e.g. under /Applications/)
2. Install the CLI tools (i.e. the fauxpas command):
   • By running /Applications/FauxPas.app/Contents/Resources/install-cli-tools, or:
   • By running the Faux Pas GUI on the CI server and selecting “Install CLI Tools…” from the application menu
3. Register your Faux Pas license on the server:
   • By running the Faux Pas GUI, or:

   • By running the following on the command line (substituting the respective actual values for the arguments):

       fauxpas updatelicense <license_type> <licensee_name> <license_key>
     

You do not need to purchase additional licenses for CI servers — you can just register any Faux Pas license you own on the servers — so long as you have a seat license for each person who uses Faux Pas via the CI servers. For more information on licensing, please refer to the license agreement.

Jenkins

If you are using Jenkins, you can install the Faux Pas plugin.

Instructions for configuring the plugin are included in the repository readme file.

The plugin is open source, which allows you to customize it however you like.

Other CI Servers

If you are using any other CI server, you may be able to manually configure it to execute Faux Pas via its command-line interface.

In these cases, make Faux Pas emit JSON output by supplying the --outputFormat json arguments, and redirect the standard output of the command into a JSON file somewhere.

Now that you have the diagnostics (serialized as JSON) sitting somewhere on the CI server, you’ll want a way to look at them via some sort of GUI. Here are a couple of options:

Leverage existing support for other checking tools

Your CI server may have support (either built-in or via a plugin) for displaying results of other static checking tools. You can use this converter script to transform the Faux Pas diagnostics JSON into a format that your CI system may understand.

The converter script is open source, which allows you to customize it however you like.

Use the standalone diagnostics presenter web app

You can install this standalone client-side web app on any web server (by simply copying some static files over), and use it to view the diagnostics produced as part of your CI builds.

The presenter web app is open source, which allows you to customize it however you like.