xcpretty-azure-formatter

This custom XCPretty Formatter converts relevant xcodebuild output into Azure Pipelines logging commands (see https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#logissue-log-an-error-or-warning) The Formatter was written with a focus on reporting build warnings and errors to the Azure environment, e.g. in Dashboards.


Keywords
ios, xcodebuild, xcpretty, azure-pipelines
License
MIT
Install
gem install xcpretty-azure-formatter -v 0.2.1

Documentation

xcpretty-azure-formatter

Build Gem Version

This xcpretty formatter produces additional Azure Pipelines LogIssue commands so xcodebuild errors and warnigns can be reported to the Azure Pipeline environment.

Installation

Add this line to your application's Gemfile:

gem 'xcpretty-azure-formatter'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install xcpretty_azure_formatter

Usage

Simply specify the azure formatter when using xcpretty. Be sure to use back-ticks. For more details see the xcpretty documentation

$ xcodebuild [args] build | xcpretty -f `xcpretty-azure-formatter` 

This will retain the original output of xcpretty, except for the following message categories which will be replaced by Azure-friendly output:

  • General warnings and errors
  • Compiler warnings and errors
  • Linker warnings
  • File Missing errors
  • Undefined Symbols errors
  • Duplicate Symbols errors

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xcpretty_azure_formatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the XcprettyAzureFormatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.