-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme #38
Update readme #38
Conversation
README.md
Outdated
|
||
This a [Google Summer of Code](https://summerofcode.withgoogle.com/) project for [Jenkins Organization](https://www.jenkins.io/), it is still under development. | ||
This plugin helps Jenkins plugins publish checks to GitHub through [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This plugin is repeated in this paragraph and the next...
This plugin helps Jenkins plugins publish checks to GitHub through [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs). | |
Publishes checks to GitHub through [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes... I don't what else needs to write here.
Codecov Report
@@ Coverage Diff @@
## master #38 +/- ##
=========================================
Coverage 77.33% 77.33%
Complexity 96 96
=========================================
Files 7 7
Lines 300 300
Branches 33 33
=========================================
Hits 232 232
Misses 48 48
Partials 20 20 Continue to review full report at Codecov.
|
@@ -23,6 +23,9 @@ This plugin has been installed, alone with the [General API Plugin](https://gith | |||
|
|||
By listening to the Jenkins builds, this plugin will automatically publish statuses (pending, in progress, and completed) to GitHub. | |||
|
|||
*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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
have you tested these out btw?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, both work on my machine
Do we also need to include warnings checks and coverage checks in this plugin's doc?