Update readme with consumers guide and features #18

XiongKezhi · 2020-08-25T16:58:45Z

Update readme

timja

no blockers but a number of suggested improvements.

timja · 2020-08-25T17:07:54Z

README.md


+Inspired by the [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs), this plugin aims to provide a general API to allow Jenkins plugins publishing checks (or reports) to remote source code management (SCM) platforms (e.g. GitHub, GitLab, BitBucket, etc.).
+By consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images.


Let's add some line breaks to break up the paragraphs this is a new topic.

Suggested change

By consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images.

By consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images.

timja · 2020-08-25T17:08:16Z

README.md


+Inspired by the [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs), this plugin aims to provide a general API to allow Jenkins plugins publishing checks (or reports) to remote source code management (SCM) platforms (e.g. GitHub, GitLab, BitBucket, etc.).
+By consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images.
+Then, the implementations of this API will decide on how to make use of these parameters and where to publish the checks.


Suggested change

Then, the implementations of this API will decide on how to make use of these parameters and where to publish the checks.

Implementations of this API decide on how to make use of these parameters and where to publish the checks.

timja · 2020-08-25T17:09:45Z

README.md


-This a [Google Summer of Code](https://summerofcode.withgoogle.com/) project for [Jenkins Organization](https://www.jenkins.io/), it is still under development.
+Current consumers of this plugin include [Warnings Next Generation Plugin](https://github.com/jenkinsci/warnings-ng-plugin) and [Code Coverage API Plugin](https://github.com/jenkinsci/code-coverage-api-plugin); current implementations include [GitHub Checks Plugin](https://github.com/jenkinsci/github-checks-plugin).


I think this looks better, might be nice to add integration pull requests so others can see how to add their own one

Suggested change

Current consumers of this plugin include [Warnings Next Generation Plugin](https://github.com/jenkinsci/warnings-ng-plugin) and [Code Coverage API Plugin](https://github.com/jenkinsci/code-coverage-api-plugin); current implementations include [GitHub Checks Plugin](https://github.com/jenkinsci/github-checks-plugin).

Known consumers:

* [Warnings Next Generation Plugin](https://plugins.jenkins.io/warnings-ng)

* [Code Coverage API Plugin](https://plugins.jenkins.io/code-coverage-api)

Implementations:

* [GitHub Checks Plugin](https://plugins.jenkins.io/github-checks)

timja · 2020-08-25T17:10:53Z

README.md

-* [Project Idea](https://www.jenkins.io/projects/gsoc/2020/project-ideas/github-checks/)
-* [Project Design](https://docs.google.com/document/d/1hVQTd9jKw0sx8JQR8KjbM-7lWW84e2vFjmmkzBpBbSk/edit?usp=sharing)
-* [Meeting Notes](https://docs.google.com/document/d/1TZLmu3nBPbwUjzLVYGnV_YtYvmzxzw6A4eEVYpbmi3Y/edit?usp=sharing)
+## Consumers Guide


I think the guide belongs in its own file in the docs directory.

I would consider moving pipeline above this, as users will want this.

timja · 2020-08-25T17:11:02Z

README.md

+ .build();
+```
+
+Then you can create a publisher based on a Jenkins `run` to publish the check you just constructed:


Suggested change

Then you can create a publisher based on a Jenkins `run` to publish the check you just constructed:

Then you can create a publisher based on a Jenkins `Run` to publish the check you just constructed:

timja · 2020-08-25T17:12:55Z

README.md

+- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion;
+- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations;
+- `ChecksAnnotation`: a code annotation of a check, providing a specific comment for one or multiple lines of code;
+- `ChecksImage`: an image of a check, providing an intuitive graph for the build like issues trend, coverage chart;


Suggested change

- `ChecksImage`: an image of a check, providing an intuitive graph for the build like issues trend, coverage chart;

- `ChecksImage`: an image of a check, providing an intuitive graph for the build like issues trend, coverage chart, must be a public URL that GitHub can fetch from

timja · 2020-08-25T17:13:00Z

README.md

+Consumers can set these parameters through the checks models:
+
+- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion;
+- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations;


Suggested change

- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations;

- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations

timja · 2020-08-25T17:13:04Z

README.md

+The checks are highly customized by consumers due to a number of optional parameters provided.
+Consumers can set these parameters through the checks models:
+
+- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion;


Suggested change

- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion;

- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion

timja · 2020-08-25T17:13:14Z

README.md

+- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations;
+- `ChecksAnnotation`: a code annotation of a check, providing a specific comment for one or multiple lines of code;
+- `ChecksImage`: an image of a check, providing an intuitive graph for the build like issues trend, coverage chart;
+- `ChecksAction`: an action of a check, providing further actions to be performed by users, like rerun a Jenkins build; 


Suggested change

- `ChecksAction`: an action of a check, providing further actions to be performed by users, like rerun a Jenkins build;

- `ChecksAction`: an action of a check, providing further actions to be performed by users, like rerun a Jenkins build

README.md

codecov · 2020-08-26T03:59:13Z

Codecov Report

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

@@            Coverage Diff            @@
##             master      #18   +/-   ##
=========================================
  Coverage     90.87%   90.87%           
  Complexity       69       69           
=========================================
  Files            11       11           
  Lines           274      274           
  Branches          6        6           
=========================================
  Hits            249      249           
  Misses           23       23           
  Partials          2        2

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 f0da812...762ef55. Read the comment docs.

timja · 2020-08-26T07:02:55Z

README.md

+Implementations:
+* [GitHub Checks Plugin](https://plugins.jenkins.io/github-checks)
+
+This plugin, alone with it's [GitHub implementation](https://plugins.jenkins.io/github-checks), has been installed on [ci.jenkins.io](https://ci.jenkins.io/Plugins) to help maintain hundreds of Jenkins plugins. You can take a look at the [action](https://github.com/jenkinsci/checks-api-plugin/runs/1025532156) for this repository or other plugin repositories under [Jenkins organization](https://github.com/jenkinsci) for the results.


Suggested change

This plugin, alone with it's [GitHub implementation](https://plugins.jenkins.io/github-checks), has been installed on [ci.jenkins.io](https://ci.jenkins.io/Plugins) to help maintain hundreds of Jenkins plugins. You can take a look at the [action](https://github.com/jenkinsci/checks-api-plugin/runs/1025532156) for this repository or other plugin repositories under [Jenkins organization](https://github.com/jenkinsci) for the results.

This plugin, along with it's [GitHub implementation](https://plugins.jenkins.io/github-checks), has been installed on [ci.jenkins.io](https://ci.jenkins.io/Plugins) to help maintain over 1500 Jenkins plugins. You can take a look at the [action](https://github.com/jenkinsci/checks-api-plugin/runs/1025532156) for this repository or other plugin repositories under [Jenkins organization](https://github.com/jenkinsci) for the results.

docs/consumers-guide.md

timja · 2020-08-26T07:05:02Z

README.md

+## Guides
+
+- [Consumers Guide](docs/consumers-guide.md)
+- [Implementation Guide](docs/implementation-guide.md)


doesn't appear to exist?

it should be added in the PR that adds it if I'm not misunderstanding

Suggested change

- [Implementation Guide](docs/implementation-guide.md)

timja · 2020-08-26T07:05:17Z

README.md

+
+## Acknowledgements
+
+This plugin is started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), you can find more about it on [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/).


Suggested change

This plugin is started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), you can find more about it on [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/).

This plugin was started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), you can find more about it on [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/).

README.md

…gins-checks-api-0.2.0 Bump checks-api from 0.1.1-rc24.26e46eb1548a to 0.2.0

Update readme with consumers guide and features

14e28f4

XiongKezhi requested a review from a team August 25, 2020 16:58

Smaller font of subtitles

0e8c647

timja approved these changes Aug 25, 2020

View reviewed changes

Improve READ.me

625167c

XiongKezhi added 2 commits August 26, 2020 11:59

Move consumers guide to individual file

d1d2c90

Add link to ci.jenkins.io

05e4378

timja reviewed Aug 26, 2020

View reviewed changes

docs/consumers-guide.md Show resolved Hide resolved

timja reviewed Aug 26, 2020

View reviewed changes

docs/consumers-guide.md Show resolved Hide resolved

timja reviewed Aug 26, 2020

View reviewed changes

README.md Show resolved Hide resolved

XiongKezhi added 2 commits August 26, 2020 16:08

Fix minor issues and add contributing and liscense section

3737d59

Improve Ackownledgements

82b1440

timja reviewed Aug 26, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

762ef55

timja approved these changes Aug 26, 2020

View reviewed changes

XiongKezhi merged commit d0557d1 into master Aug 26, 2020

XiongKezhi deleted the document branch August 26, 2020 08:41

XiongKezhi added a commit that referenced this pull request Oct 25, 2020

Merge pull request #18 from jenkinsci/dependabot/maven/io.jenkins.plu…

11392dc

…gins-checks-api-0.2.0 Bump checks-api from 0.1.1-rc24.26e46eb1548a to 0.2.0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme with consumers guide and features #18

Update readme with consumers guide and features #18

XiongKezhi commented Aug 25, 2020 •

edited

Loading

timja left a comment

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

timja Aug 25, 2020

codecov bot commented Aug 26, 2020 •

edited

Loading

timja Aug 26, 2020

timja Aug 26, 2020

timja Aug 26, 2020


		Inspired by the [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs), this plugin aims to provide a general API to allow Jenkins plugins publishing checks (or reports) to remote source code management (SCM) platforms (e.g. GitHub, GitLab, BitBucket, etc.).
		By consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images.

	Then, the implementations of this API will decide on how to make use of these parameters and where to publish the checks.
	Implementations of this API decide on how to make use of these parameters and where to publish the checks.


		This a [Google Summer of Code](https://summerofcode.withgoogle.com/) project for [Jenkins Organization](https://www.jenkins.io/), it is still under development.
		Current consumers of this plugin include [Warnings Next Generation Plugin](https://github.com/jenkinsci/warnings-ng-plugin) and [Code Coverage API Plugin](https://github.com/jenkinsci/code-coverage-api-plugin); current implementations include [GitHub Checks Plugin](https://github.com/jenkinsci/github-checks-plugin).

-Current consumers of this plugin include [Warnings Next Generation Plugin](https://github.com/jenkinsci/warnings-ng-plugin) and [Code Coverage API Plugin](https://github.com/jenkinsci/code-coverage-api-plugin); current implementations include [GitHub Checks Plugin](https://github.com/jenkinsci/github-checks-plugin).
+Known consumers:
+* [Warnings Next Generation Plugin](https://plugins.jenkins.io/warnings-ng)
+* [Code Coverage API Plugin](https://plugins.jenkins.io/code-coverage-api)
+Implementations:
+* [GitHub Checks Plugin](https://plugins.jenkins.io/github-checks)

	Then you can create a publisher based on a Jenkins `run` to publish the check you just constructed:
	Then you can create a publisher based on a Jenkins `Run` to publish the check you just constructed:

	- `ChecksImage`: an image of a check, providing an intuitive graph for the build like issues trend, coverage chart;
	- `ChecksImage`: an image of a check, providing an intuitive graph for the build like issues trend, coverage chart, must be a public URL that GitHub can fetch from

	- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations;
	- `ChecksOutput`: the output of a check, providing some displayed details like title, summary, URL, and code annotations

	- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion;
	- `ChecksDetails`: the top-level model of a check, including all other models and some basic parameters like status and conclusion

	- `ChecksAction`: an action of a check, providing further actions to be performed by users, like rerun a Jenkins build;
	- `ChecksAction`: an action of a check, providing further actions to be performed by users, like rerun a Jenkins build


		## Acknowledgements

		This plugin is started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), you can find more about it on [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/).

	This plugin is started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), you can find more about it on [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/).
	This plugin was started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), you can find more about it on [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/).

Update readme with consumers guide and features #18

Update readme with consumers guide and features #18

Conversation

XiongKezhi commented Aug 25, 2020 • edited Loading

timja left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Aug 26, 2020 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

XiongKezhi commented Aug 25, 2020 •

edited

Loading

codecov bot commented Aug 26, 2020 •

edited

Loading