Skip to content
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

Merged
merged 3 commits into from
Aug 27, 2020
Merged

Update readme #38

merged 3 commits into from
Aug 27, 2020

Conversation

XiongKezhi
Copy link
Contributor

Do we also need to include warnings checks and coverage checks in this plugin's doc?

@XiongKezhi XiongKezhi requested a review from a team August 26, 2020 12:44
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).
Copy link
Member

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...

Suggested change
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).

Copy link
Contributor Author

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
Copy link

codecov bot commented Aug 26, 2020

Codecov Report

Merging #38 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0c5db0...e5966c6. Read the comment docs.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@timja timja added the documentation Improvements or additions to documentation label Aug 26, 2020
@@ -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).
Copy link
Member

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?

Copy link
Contributor Author

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

@XiongKezhi XiongKezhi merged commit b555fc4 into master Aug 27, 2020
@XiongKezhi XiongKezhi deleted the update-readme branch August 27, 2020 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants