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.

Sign up for GitHub

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

Add withChecks step #49

Merged
merged 11 commits into from
Dec 20, 2020
Merged

Add withChecks step #49

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
dad6572
Add withChecks step
XiongKezhi Nov 29, 2020
7b78a3b
Add test for WithChecksStep.
XiongKezhi Dec 14, 2020
80e6a26
Add document and snippet generator support.
XiongKezhi Dec 16, 2020
f4b246a
Bump version to 1.2.0 for adding ChecksInfo and WithChecksStep.
XiongKezhi Dec 16, 2020
637b847
Merge branch 'master' into implement_with_checks_step
XiongKezhi Dec 16, 2020
c76461f
remove unused setter
XiongKezhi Dec 16, 2020
d37be34
Remove unused import
XiongKezhi Dec 16, 2020
69a09ff
Add callback for withChecks.
XiongKezhi Dec 17, 2020
d38dbf6
Add consumer doc.
XiongKezhi Dec 19, 2020
a45182e
Remove unnessary denpendency version in pom
XiongKezhi Dec 19, 2020
e724c04
Improve consumer doc
XiongKezhi Dec 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/consumers-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,13 @@ Consumers can set these parameters through the checks models:

The publishers are created through the static factory method (`fromRun` or `fromJob`) of `ChecksPublisherFactory`.
The factory will iterate all available implementations of the `ChecksPublisher` in order to find the suitable publisher for the Jenkins `Run` or `Job`.

## Pipeline Step: withChecks

The withChecks step injects a `ChecksInfo` object into its closure so that other plugin developers can resolve them in their [Step](https://javadoc.jenkins.io/plugin/workflow-step-api/org/jenkinsci/plugins/workflow/steps/Step.html) implementation:

```
getContext().get(ChecksInfo.class)
```

Currently, the `ChecksInfo` object only includes a `name` specified by users.
XiongKezhi marked this conversation as resolved.
Show resolved Hide resolved
1 change: 0 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>display-url-api</artifactId>
<version>2.3.3</version>
</dependency>

<dependency>
Expand Down