A Jenkins CI plugin for running Faux Pas on Xcode projects
Java Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src/main
.gitignore
LICENSE
README.md
make_release.sh
pom.xml

README.md

Faux Pas Jenkins Plugin

This is a plugin for running Faux Pas in the Jenkins continuous integration server.

Installation

This plugin is not yet available in the standard Jenkins repositories, so you must download the .hpi file (from the dist/ folder in this repository) and install it manually via Manage Jenkins > Manage Plugins > Advanced > Upload Plugin in the Jenkins GUI.

Usage

  1. Open the configuration page for the desired job
  2. Add build step “Faux Pas”
  3. Configure the project and Faux Pas config file paths for the build step (it is recommended to have a separate Faux Pas configuration file in your project repository for CI — refer to this file here)
  4. Add post-build action “Publish Faux Pas checking results”

It is recommended to configure the minErrorStatusSeverity option in the Faux Pas configuration file — this allows you to control when Faux Pas returns a nonzero exit status (which will break the CI build).

Building

  1. Run mvn package
  2. The built plugin can be found at: target/fauxpas-plugin.hpi