Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f-meloni/danger-swift-xcodesummary
A Danger-Swift plugin that adds build errors, warnings and unit tests results generated from xcodebuild to your Danger report
https://github.com/f-meloni/danger-swift-xcodesummary
build danger danger-plugin danger-report danger-swift reporting spm swift swift-package-manager tests xcode xcodebuild xcpretty
Last synced: 4 months ago
JSON representation
A Danger-Swift plugin that adds build errors, warnings and unit tests results generated from xcodebuild to your Danger report
- Host: GitHub
- URL: https://github.com/f-meloni/danger-swift-xcodesummary
- Owner: f-meloni
- Created: 2019-01-06T13:39:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-20T16:07:08.000Z (about 2 years ago)
- Last Synced: 2024-02-28T06:44:25.332Z (4 months ago)
- Topics: build, danger, danger-plugin, danger-report, danger-swift, reporting, spm, swift, swift-package-manager, tests, xcode, xcodebuild, xcpretty
- Language: Swift
- Homepage:
- Size: 3.77 MB
- Stars: 74
- Watchers: 2
- Forks: 15
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Lists
- awesome-danger - danger-swift-xcodesummary - Adds build errors, warnings and unit tests results generated from xcodebuild to your Danger report (Plugins / Swift (danger-swift))
- awesome-stars - f-meloni/danger-swift-xcodesummary - A Danger-Swift plugin that adds build errors, warnings and unit tests results generated from xcodebuild to your Danger report (Swift)
README
# DangerXCodeSummary
A Danger-Swift plugin that adds build errors, warnings and unit tests results generated from xcodebuild to your Danger report
Inspired by [danger-xcode_summary](https://github.com/diogot/danger-xcode_summary)
## Getting Started
- Install [xcpretty](https://github.com/supermarin/xcpretty) and
[xcpretty-json-formatter](https://github.com/marcelofabri/xcpretty-json-formatter)
### Install DangerSwiftCoverage
#### Swift Package Manager (More performant)
You can use a "full SPM" solution to install both `danger-swift` and `DangerXCodeSummary`.
- Add to your `Package.swift`:
```swift
let package = Package(
...
products: [
...
.library(name: "DangerDeps", type: .dynamic, targets: ["DangerDependencies"]), // dev
...
],
dependencies: [
...
// Danger Plugins
.package(url: "https://github.com/f-meloni/danger-swift-xcodesummary", from: "0.1.0") // dev
...
],
targets: [
.target(name: "DangerDependencies", dependencies: ["Danger", "DangerXCodeSummary"]), // dev
...
]
)
```
- Add the correct import to your `Dangerfile.swift`:
```swift
import DangerXCodeSummary
let summary = XCodeSummary(filePath: "result.json")
```
- Create a folder called `DangerDependencies` on `Sources` with an empty file inside like [Fake.swift](Sources/DangerDependencies/Fake.swift)
- To run `Danger` use `swift run danger-swift command`
- (Recommended) If you are using SPM to distribute your framework, use [Rocket](https://github.com/f-meloni/Rocket), or similar to comment out all the dev depencencies from your `Package.swift`.
This prevents the dev dependencies to be downloaded and compiled with your framework.
#### Marathon
- Add this to your `Dangerfile.swift`
```swift
import DangerXCodeSummary // package: https://github.com/f-meloni/danger-swift-xcodesummary.git
let summary = XCodeSummary(filePath: "result.json")
```
- (Recommended) Cache the `~/.danger-swift` folder
## Run with SPM
DangerXCodeSummary can be used with SPM (this repo uses it on the Linux CI), but at the moment, if you use SPM, falining tests inline messages are not generated.
To generate the report run:
```bash
swift test | XCPRETTY_JSON_FILE_OUTPUT=result.json xcpretty -f `xcpretty-json-formatter`
```
## Send report to Danger
```swift
summary.report()
```
## Warning and Errors count
```swift
if summary.errorsCount > maxErrorCount {
fail("There are more than \(maxErrorCount) errors"
}
if summary.warningsCount > maxWarningsCount {
fail("There are more than \(maxWarningsCount) warnings"
}
```
## Filtering results
Don't show warnings:
```swift
let summary = XCodeSummary(json: JSONFile.jsonObject(fromString: reportTestJSON), dsl: dsl, resultsFilter: { result in
return result.category != .warning
})
summary.report()
```
Filter out any error or warning for a specific path:
```swift
let summary = XCodeSummary(json: JSONFile.jsonObject(fromString: warningsJSON), dsl: dsl, resultsFilter: { result in
guard let file = result.file else { return true }
return !file.contains("Sources/DangerXCodeSummary/")
})
summary.report()
```