jenkinsci/github-checks-api

GSoC 2020 - GitHub Checks API for Jenkins Plugins. https://www.jenkins.io/projects/gsoc/2020/projects/github-checks/

Tim Jacomb

@timja

by default it's success

but otherwise users should be able to set something

but all that can be a follow up pull request

we could just start small with what you said

and then iterate

Kezhi Xiong

@XiongKezhi

yes, I add default values: success for conclusion and completed for status

Tim Jacomb

@timja

cool sounds good

I think go with what you said for the initial PR

and then we can build it up as we go

thinking of the user first

Kezhi Xiong

@XiongKezhi

:+1:

Tim Jacomb

@timja

and not the underlying data model :)

Kezhi Xiong

@XiongKezhi

Tim Jacomb

@timja

@uhafner do we need both java and javadoc tools in pipeline-library?

they seem to publish duplicates

https://github.com/jenkinsci/ldap-plugin/pull/48/files

i hit the same on the slack plugin when i introduced a checkstyle errror

Ullrich Hafner

@uhafner

I think the parsers use different regular expressions, maybe the output of one of the tools changed?

Ullrich Hafner

@uhafner

I created a quick fix: jenkinsci/analysis-model#486 (all messages with a @will be ignored by the AntJava parser now). I also created a followup issue https://issues.jenkins-ci.org/browse/JENKINS-63346, since I am not sure if that will skip all those warnings.

Ullrich Hafner

@uhafner

@XiongKezhi @timja one thing that I noticed when creating that PR: When I commit a new branch then Jenkins builds the branch and creates notifications in GitHub for this branch. When I create the PR a couple of minutes later, then the PR will already contain checks results even though the Jenkins build has not been started. This is somehow a litte bit strange. Is there a way to avoid this? It seems that the IDs of the checks are only using the commit hash which are the same for the branch and the PR.

Kezhi Xiong

@XiongKezhi

After you created the PR, will the build start immediately, then send new checks to github? I think we can’t do much for it, since we can’t control what triggers the builds. I guess it’s because the gihub-branch-source subscribes both the new branch and new PR event.

Tim Jacomb

@timja

yeah it's because both branches and pr-merges are being built

it will exclude it if you open the PR quick enough

it's currently set to not build branches that are also PRs

but if the branch is pushed earlier it will still build both

@uhafner do we need to something about checkstyle as well/

as that has the same issue as javadoc?

Ullrich Hafner

@uhafner

This is a little bit different. These issues are now created by different tools. If you do not want to check for ˋ@paramˋ in CheckStyle then it makes more sense to adapt the CheckStyle rules set.

Tim Jacomb

@timja

https://github.com/jenkinsci/slack-plugin/pull/717/files

an example using imports and not javadoc ^^

it seems like it's picking up the checkstyle warnings

Oleg Nenashev

@oleg-nenashev

@timja @XiongKezhi what is your preference about time on Aug 17? 1PM utc or 4PM utc would be the best options for me

Kezhi Xiong

@XiongKezhi

1pm is good for me

Ullrich Hafner

@uhafner

an example using imports and not javadoc, it seems like it's picking up the checkstyle warnings

You are using the wrong goal, you need to invoke checkstyle. The check goal does not produce the XML file and reports to the console. Example of a correct checkstyle configuration: https://github.com/jenkinsci/analysis-pom-plugin/blob/master/pom.xml#L316

Tim Jacomb

@timja

ah right

thanks

@oleg-nenashev just checked my calendar and my only time on the 17th free is 12pm utc, but i'm pretty much free most of the day on the 18th or 19th if that's better

or 11am utc

Kezhi Xiong

@XiongKezhi

I’m ok for 18th, 19th as well

Oleg Nenashev

@oleg-nenashev

18 or 19 is also better for me

Tim Jacomb

@timja

ATH failures introduced adding checks-api to warnings-ng: https://issues.jenkins-ci.org/browse/JENKINS-63353

Ian

@ianfixes

Hello, I'm this guy: https://issues.jenkins-ci.org/browse/JENKINS-51225?focusedCommentId=381991&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-381991

I didn't see anything in the docs about what interface is presented to the scripted pipeline. If I want to use this plugin to send my own set of GitHub annotations, what goes in the Jenkinsfile to make that happen?

Kezhi Xiong

@XiongKezhi

Sorry, the pipeline support is still on going: jenkinsci/checks-api-plugin#7. By the end of this month, everything will be available. You can comment on this PR for your use case if you like, we would love to include that :). Beside the direct pipeline use of this plugin, we have implemented two consumers and support pipeline: warnings-ng and code-coverage, you can check out this blogpost: https://www.jenkins.io/blog/2020/08/03/github-checks-api-plugin-coding-phase-2/

@ianfixes

Tim Jacomb

@timja

@ianfixes if you could share what sort of info you want to send for your checks that would be great

our sample usage for the simplest version is something like:

publishChecks(
  name: "MyCheck",
  conclusion: "success",
  summary: "Everything is OK!"
)

Oleg Nenashev

@oleg-nenashev

@timja @XiongKezhi @uhafner Link for the online meetup slot selection: https://doodle.com/poll/dyghz9ach8cwrx5f

Tim Jacomb

@timja

@oleg-nenashev is there a reason that they all start at 45 minutes past?

is that to check before hand its working?

Oleg Nenashev

@oleg-nenashev

yes @timja

Where communities thrive

People

Repo info

Activity