Clang Static Analyzer plugin for Fastlane
Switch branches/tags
Nothing to show
Clone or download
SiarheiFedartsou Merge pull request #3 from mgrebenets/update-readme
Add new clean and log_file_path options to example
Latest commit 16ab495 Jan 24, 2017

README.md

clang_analyzer plugin

CI Status fastlane Plugin Badge

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-clang_analyzer, add it to your project by running:

fastlane add_plugin clang_analyzer

Then you need to download standalone Clang Static Analyzer. By default plugin will look for analyzer at ~/analyze_tools. To run Clang Static Analyzer add clang_analyzer action call in one of lanes in your Fastfile.

About clang_analyzer

Runs Clang Static Analyzer on your codebase and generates analysis report.

Example

Check out the example Fastfile to see how to use this plugin. Try it by cloning the repo, running fastlane install_plugins and bundle exec fastlane test in ./example folder. Example of analyzer report can be found here.

Actions

clang_analyzer

clang_analyzer(
  analyzer_path: '~/analyze_tools/bin', # optional
  clean: true, # optional
  workspace: 'Test.xcworkspace', # optional, cannot be used together with `project` option
  project: 'Test.xcodeproj', # optional, cannot be used together with `workspace` option
  configuration: 'Debug', # optional
  sdk: 'iphonesimulator', # optional
  arch: 'i386', # optional
  report_output_path: 'analyzer_report', # optional
  log_file_path: 'analyzer_report.log', # optional
)

Jenkins integration

You can easily integrate this plugin to Jenkins using Jenkins HTML Publisher Plugin. Just pass path to generated report to this plugin.

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting doc in the main fastlane repo.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out fastlane.tools.