Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scior/danger-xcode_warnings

📡Danger plugin for analyzing the result from xcodebuild
https://github.com/scior/danger-xcode_warnings

danger danger-plugin xcode xcodebuild

Last synced: 28 days ago
JSON representation

📡Danger plugin for analyzing the result from xcodebuild

Host: GitHub
URL: https://github.com/scior/danger-xcode_warnings
Owner: Scior
License: mit
Created: 2019-07-10T07:48:17.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-25T03:23:04.000Z (almost 2 years ago)
Last Synced: 2024-11-16T22:39:30.058Z (about 2 months ago)
Topics: danger, danger-plugin, xcode, xcodebuild
Language: Ruby
Homepage:
Size: 334 KB
Stars: 6
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# danger-xcode_warnings

[![Gem Version](https://badge.fury.io/rb/danger-xcode_warnings.svg)](https://badge.fury.io/rb/danger-xcode_warnings)
![Build Status](https://github.com/Scior/danger-xcode_warnings/workflows/Ruby%20Gem/badge.svg)
[![version](https://img.shields.io/badge/Xcode-11-blue.svg)](https://developer.apple.com/xcode/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Danger plugin to format and show warnings from `xcodebuild`.

![Sample](doc/sample.png)

## Features

- Extract the compiler and linker warnings from the build log and format them for Danger
- Both `xcodebuild` and `xcpretty` format are supported
- Gather the build timing summary and show

## Installation

```sh
gem install danger-xcode_warnings
```

Or using Bundler,

```ruby
gem 'danger-xcode_warnings'
```

## Usage

### With xcodebuild

Firstly, collect the log from `xcodebuild`.

```sh
xcodebuild clean build -workspace ... > build.log
# If you want to show the log with xcpretty
xcodebuild clean build -workspace ... | tee build.log | xcpretty
```

And then, call `analyze_file` method in your `Dangerfile` to analyze the build log,

```ruby
xcode_warnings.analyze_file 'build.log'
```

with some shell scripts with your CI, like:

```sh
bundle install
bundle exec danger
```

### With xcpretty

If you want to analyze the xcpretty log, you MUST set the `use_xcpretty` flag in your `Dangerfile`:

```ruby
xcode_warnings.use_xcpretty = true
xcode_warnings.analyze_file 'build.log'
```

Your build script for CI should be like,

```sh
xcodebuild clean build -workspace ... | xcpretty > build.log
```

### Show linker warnings

To show linker warnings, set the `show_linker_warnings` to `true` before analyzing the log:

```ruby
xcode_warnings.show_linker_warnings = true
xcode_warnings.analyze_file 'build.log'
```

### Gathering build timing sumamry

To gather the build timing summary, you have to add `-showBuildTimingSummary` option to your build script:

```sh
xcodebuild clean build -workspace ... -showBuildTimingSummary > build.log
```

Then, set the `build_timing_summary` flag to `true`.

```ruby
xcode_warnings.build_timing_summary = true
xcode_warnings.analyze_file 'build.log'
```

### See also

`RubyDoc` for this plugin is here:

## 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.