Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.35 KB

README.md

File metadata and controls

56 lines (40 loc) · 1.35 KB

danger-xcprofiler

GitHub Action Gem Version

danger plugin for asserting Swift compilation time.

See detail for README of xcprofiler.

Installation

Add this line to your Gemfile:

gem 'danger-xcprofiler'

Usage

Just add this line to your Dangerfile:

xcprofiler.report 'MyApp'

Or specify an xcactivitylog path

logDir = Dir[File.join('DerivedData/Logs/Build/', '*.xcactivitylog')].first
xcprofiler.report nil, nil, logDir

If compilation times of each methods are exceeded the thresholds, danger adds inline comment to your PR.

Default thresholds is 50ms for warning, 100ms for failure.

If you want to change thresholds see the following:

# Defines inline_mode
xcprofiler.inline_mode = false
# Defines thresholds (ms)
xcprofiler.thresholds = {
  warn: 100,
  fail: 500
}
xcprofiler.report 'MyApp'

Development

  1. Clone this repo
  2. Run bundle install to setup dependencies.
  3. Run bundle exec rake spec to run the tests.
  4. Use bundle exec guard to automatically have tests run as you make changes.
  5. Make your changes.