Revert "temporarily rm ci reporter"

This commit is contained in:
Jason Etcovitch
2018-10-30 17:09:59 -04:00
committed by GitHub
parent 742f44f569
commit d8c333ad38

57
_apps/ci-reporter.md Normal file
View File

@@ -0,0 +1,57 @@
---
title: CI Reporter
description: Pastes the error output of a failing build into the relevant PR.
slug: ci-reporter
screenshots:
- https://user-images.githubusercontent.com/10660468/36135324-78809222-1058-11e8-99cd-6cc100971066.png
authors:
- JasonEtco
repository: JasonEtco/ci-reporter
host: https://ci-reporter-etc.herokuapp.com
stars: 35
updated: 2018-06-16 14:17:27 UTC
installations: 73
organizations:
- ant-design
- ReactiveX
- veggiemonk
- explosion
- semantic-release
- thibmaek
- octokit
- offu
- Radarr
- gillesdemey
---
## Usage
Simply [install the app](https://github.com/apps/ci-reporter) and watch the magic happen as your Pull Requests trigger failure statuses.
## How it works
When a build fails, the CI provider will tell GitHub (via a status). GitHub then tells **ci-reporter** about a failed status, and it'll find the part of the build that failed, then comment back on the PR.
## Configuration
You don't need any configuration for this to work in your project but you can customize a few things to fit your needs. You can create a `.github/ci-reporter.yml` file:
```yml
# Set to false to create a new comment instead of updating the app's first one
updateComment: true
# Use a custom string, or set to false to disable
before: "✨ Good work on this PR so far! ✨ Unfortunately, the [{{ provider }} build]({{ targetUrl }}) is failing as of {{ commit }}. Here's the output:"
# Use a custom string, or set to false to disable
after: "I'm sure you can fix it! If you need help, don't hesitate to ask a maintainer of the project!"
```
If you need more configuration, please [let me know in a new issue](https://github.com/JasonEtco/ci-reporter/issues/new?title=[Config]&body=Can%20you%20please%20add%20the%20___%20config%20option).
## Does it work with _____?
**ci-reporter** currently supports TravisCI and CircleCI. If you're interested in seeing support for another CI tool, please [open an issue](https://github.com/JasonEtco/ci-reporter/issues/new)!