Jenkins Google Summer of Code Office Hours, 30 Aug 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: GSoC 2020 - GitHub Checks API for Jenkins project - Final Demo

Description

Presentation by Kezhi Xiong, GSoC 2020 student in the Jenkins project The GitHub Checks API allows developers to report the CI integrations’ detailed information rather than the binary pass/fail build status on GitHub pages. This project is about implementing this API as a new Jenkins plugin. By consuming this API, other plugins can easily create GitHub checks. Thus, any information during the Jenkins process like warnings, summaries, and durations can be directly shown on GitHub pages.

Talk abstract: In this talk, I’ll go through what GitHub check run is, how it could benefit the developers. Then, I’ll present how Jenkins plugins could integrate with that, and how Warnings NG and Code Coverage API plugins integrate with GitHub Checks.

References:

* Project page: https://www.jenkins.io/projects/gsoc/2020/projects/github-checks
* Checks API Plugin: https://plugins.jenkins.io/checks-api/
* GitHub Checks API Plugin: https://plugins.jenkins.io/github-checks/

A

I'm ready I shared.

A

Okay, I assume you can see my screen. Yes, we can.

A

A

So hi everyone, I'm koji today, I'm going to show you my I just project, github checks, api plugin for jenkins and my mentors are woolly and the team. So first I want to show you our product of this project. The first way I released the general checks api plugin, where we provide this to be prepared for similar concepts in different platforms like github gitlab, with bucket or some other platforms, and we also provide the implementation for github.

A

It's called lab checks, plugin and after that you can consume our api to publish checks to github like these, and we have not released both plugins. We can just go to the plugin center and install our plugin. Try it after release of plugins, we consumed our api in warnings, plugin sorry, it should be what is next generation plugin and we have. uh We have the following features like the qualitate. There are red x and some green checks here this.

A

That indicates the quality gate, and you can see many states issue statistics here and you can- or you can also send me annotations for the new issues. So I show you, since our plugin has already been deployed to the set.jenkins style, so you can just go to any plugin or jenkins under the organization and and ankitab, so you can see it.

A

For example, this is a rerun request, proquest for our plugin, and if you go to checks, uh you can see many a an analysis from the tools and you can also you can also see them along the code.

A

Okay, so you can there's the cpd worry and if you take a look at the rule output, those are just parsed from the uh from the x xml file from from those tools or cpd variants.

A

And the next is about the pipeline usage of the warnings plugin and it's basically uh the same as the warnings plug-in pipeline and but we added added a feature to skip the publishing checks. I just add this field and set it true, so it can help you. If you don't want uh the checks, you can just skip those checks by adding this field, and here is the document about the awareness plugins pipeline usage.

A

Let's see more here.

A

And and not besides, the warnings next generation plug-in we're also consumed our api.

A

In the code coverage api plug-in and in this usage we show you, the coverage trend and the coverage health base score and different kinds of coverages, and you can also uh you use this feature skip this feature in the pipeline, just as just the same as the uh martin's plugin, and you just need to add these features here and- and you can also I'll say a section in the configuration page and like this- and you said you can and just check this box.

A

If you want to skip the checks- and you can also directly use the pipeline and to to publish your customized checks. um For example, you just need to add this function in your pipeline script at the name conclusion and summary, and then it will automatically publish this check for you. um You may want to use this feature to indicate the stage of your field, um for example, if somebody, if some stage costs many times much time you can, you can use this feature to help.

A

You keep keep up with the uh what's going on in the build.

A

And next we also added the rerun request, um so the users can just request the rerun for a failed check directly directly on github and when the check failed and get up either. The github will just automatically add a rerun button here. So after you click it and we will, we will schedule a build for you and you can see the course for the build is rerun request by me through the gap checks api, and this is still a feature and this I would have to merge this progress.

A

So yes, because I'm still waiting for some dependencies updates uh before merging this.

A

Okay, so, and then the next part uh is I'll, show you how to consume our api to create the checks. So because you may say uh this is very complete code here, um but this that's because there are many so many options that you can configure for check um for the simplest, for I just show you all the fields here, so it it produces much code, but in the simplest usage you may just need a name status, um details url, uh it's very easy and at last you have to create a publisher.

A

You just invoke the static factory method and it will return a suitable publisher for you. If you are using a freestyle project, I will return publisher for the three step project if you are using a github branch source plugin and get a branch source project or just a github organ folder project, where we also return a publisher for that, the next part is, I show you how to create actions.

A

um If you just want to create actions on github and so one click, a request will be sent to github app. In this case. The github app is the jenkins, and so you just need to and later implement some logic to implement that action and uh it can just make the jenkins more are convenient for the github users, for example. I just if I want to add two buttons here: one is format. Another one is report.

A

I just need to create the details with actions, so here just add two actions, a format and a report, and it will automatically add those two buttons for you.

A

So later you may want to implement those actions, and so first you want, when the users click that button you'll receive a request from the from github, and there is a section in the payload. The request, action and the field is identifier, so you can, if you want to handle this um request, you just want just need to extend the even the subscriber it's provided by the github plugin.

A

You extend it and subscribe to the archicad event, implement the even handling logic you implement those logic in the unevent method.

A

So you can just create and you can just implement the actions for the users. If you want to see more examples, you can just go to the github plugin. There are many examples like the push, push event subscriber and ping event subscriber, and you can also see our subscriber for the wrong request.

A

That's how we implement here.

A

So in the demo part uh first that since our plugin has already been installed on set.drinking style,.

A

So if we go to the plugins folder.

A

And if we some say some plugins build.

A

And we go choose uh go to the github branch.

A

Yes here, if you go to check and you'll see those uh checks for this proquest yeah, it seems a very good progress without any issues.

B

And if you go to this, if you click this thing, it will just.

A

Direct lead you to the to the ocean view of the dispute, and the next part I want to show you is the real request.

A

A

Okay, I'll find the page for the reroll.

A

Okay, so here I have a field request for the check. So if I click this rerun button here, github will give you feedback. We have successfully requested the gen case reron and and then, since I'm using a sme forwarder delivery, so you can we'll just deliver the request to our to my jenkins. You can see here in the log, it says, receive the rerun request through github checks, api and the next message is, it says, is scheduled rerun for the job and it's requested by me, and this user name is parsed from the request payload.

A

So it's the github user id and if you go to, if you go to the jenkins.

A

So you could use a spew you'll see. The cause is because rerun is a rerun request by me through the github checks, api and another part. Besides the uh request, I want to also show you the pipeline support. uh This is a pipeline generator. So I add these fields here. um Since some fields, uh the github supports markdown for some fields. I use a markdown on syntax here, so I generate the python script and I copy this so for quick demo. I just I want to replay the replay feature.

A

I'll just copy this as this there and I click, run.

A

Yeah, so if I go to the page for this, you can see here, you still could refresh this page.

A

Yeah, you can succeed 30 seconds ago and you can also click this link here. It also I'll lead you to the uh url, because this leads us to the setup drinking style, because I said the uh url here. So okay.

C

Okay, so that's pretty much from the side and if any questions you can just ask and- and we also would like to have any suggestions from you.

C

Thank you. uh If you want to see more details about this project uh one week ago,.

D

There was jenkins online meetup, where we were specifically talking about uh github apple identification and checks, api integration. So there is a bit more details there and yeah thanks a lot to casual for the presentation. Again, if you have questions, please use coney and meanwhile, maybe only your team would like to share some feedback.

D

Yeah, I can thank you first of all for this wonderful enhancement in jenkins, and we already have now two.

A

Plugins that are using this.

D

Extension and I hope a lot of different reporting plugins will come again. So, for instance, we can hit mutation coverage, show them or we can use the test results published using this approach. I'm really looking forward.

E

On different plugins implementing this new api.

E

And maybe one extension: it works not only for github branch sources. Now it works also for freestyle builds and for normal pipelines as.

F

Well, so, thank you, yeah yeah thanks thanks kizzy. It was really good. I think yeah, given the mornings in general, it's on seattle.com.

C

It's already getting a lot of adoption, probably faster than most g stock projects in the past, so I think it's a really good achievement uh as one of the grateful users of your your your contribution to cio at jenkins.io, thanks very much kg I've loved what you did with this. It's made my life better. Thank you. Thank you.

C

Everybody, if you will keep evolving that, but even the first integration steps they have been a really good advantage and uh thanks to lead team for also doing their ground work to integrate static analysis.

B

In our default pipelines I mean we had find bugs spot bugs before, but now we have basically all checks available, so something like eight different tools and we can keep expanding that yeah. I believe in the future we will be able to get more analytics.

F

Features as a part of the engine.

F

Yeah one one more thing: the the digital feature seems to be very, very good, because currently you can't sometimes rerun builds. You have to push an empty comment.

C

So is that is that a feature that um that you need to be an admin or an owner of the repository to be able to trigger a rerun or anyone can trigger a rerun? Yes, unfortunately, we've got to add the ability to do get ops. We haven't done that yet or chat. Ops is what we need. Did your right, sladen, it's it's too inconvenient right now on seattlejenkins.io, that's coming yeah proceeding. Can.

E

Say we have a plugin github comment plugin, which retriggers the build? If you have the right permissions, but we we haven't integrated it to charging cyo yet. But if you're interested, you can find this plugin in the plugin.

C

E

I'm not sure exactly what the permission is, but.

C

I would expect that if you're the author, you can probably rerun it.

A

Does anyone know something we can test or offline with the meeting yeah, I'm pretty sure, I'm pretty sure authors can do it, but we'll figure it out.

A

A

Okay, so at last I just want to say thanks to all my mentors, willie and tin, I actually received a lot of helps from you and, although there's some time gap, but I can always receive many in-time reply and many techniques and the skills you told me it's a fantastic summer and those skills I can migrate them to some other projects, maybe just outside jenkins as well, and I think I want you also thanks to the people from the whole community.

A

This is a fantastic community, very helpful and friendly, and then also thank you to introduce me to the open source world and just thanks.

A

Okay, I'll stop your school! Thank you for feedback, thanks again for the presentation, so the last presentation uh for today sladen will present carton jenkins distribution, build service, yeah I'll share my screen. Okay,.