mirror of
https://github.com/zhigang1992/probot.github.io.git
synced 2026-06-14 09:58:58 +08:00
58 lines
1.9 KiB
Markdown
58 lines
1.9 KiB
Markdown
---
|
|
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: 33
|
|
updated: 2018-04-10 19:47:13 UTC
|
|
installations: 29
|
|
organizations:
|
|
- thibmaek
|
|
- probot
|
|
- Radarr
|
|
- gillesdemey
|
|
- ahmadnassri
|
|
- timvideos
|
|
- tunnckoCore
|
|
- electron
|
|
- nice-registry
|
|
- Unibeautify
|
|
---
|
|
## 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)!
|