Skip to content

Commit

Permalink
Update instructions regarding GitHub Branch Source Plugin notificatio…
Browse files Browse the repository at this point in the history
…ns (#373)

* Update instructions regarding GitHub Branch Source notifications

* Explain how to configure the option
  • Loading branch information
ViliusS authored Jan 21, 2024
1 parent c724318 commit fa2c600
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This plugin has been installed, along with the [General API Plugin](https://gith
- [Contributing](#contributing)
- [Acknowledgements](#acknowledgements)
- [LICENSE](#license)

## Getting started

Only GitHub Apps with proper permissions can publish checks, this [guide](https://github.com/jenkinsci/github-branch-source-plugin/blob/master/docs/github-app.adoc) helps you authenticate your Jenkins instance as a GitHub App.
Expand All @@ -38,8 +38,7 @@ You can customize it by configuring the "Status Checks Properties" behavior for

![Status Checks Properties](docs/images/status-checks-properties.png)

*Note: If you are using [GitHub Branch Source Plugin](https://github.com/jenkinsci/github-branch-source-plugin), it will also send status notifications to GitHub through [Status API](https://docs.github.com/en/rest/reference/repos#statuses).
You can disable it by using [Disable GitHub Multibranch Status Plugin](https://github.com/jenkinsci/disable-github-multibranch-status-plugin) or [Skip Notification Trait Plugin](https://github.com/jenkinsci/skip-notifications-trait-plugin).*
*Note: If you are using [GitHub Branch Source Plugin](https://github.com/jenkinsci/github-branch-source-plugin), it will also send status notifications to GitHub through [Status API](https://docs.github.com/en/rest/reference/repos#statuses). You can disable those notifications by configuring Skip GitHub Branch Source notifications option.*

### Rerun Failed Build

Expand Down
Binary file modified docs/images/status-checks-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa2c600

Please sign in to comment.