Jenkins Google Summer of Code Office Hours, 30 May 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Demo: GitHub Checks API Plugin prototype for Jenkins

Description

Kezhi Xiong, a GSoC 2020 student, will show a prototype of the new GitHub Checks API Plugin for Jenkins he is working on during the summer project. There will be a demo of the plugin. Then we will take a look at the current design including the basic logic and API design, anddiscuss ways to contribute and provide feedback about the project.

References:
* Project page: https://www.jenkins.io/projects/gsoc/2020/projects/github-checks/
* Plugin repository: https://github.com/XiongKezhi/checks-api-plugin
* GitHub Checks API: https://developer.github.com/v3/checks/

A

Hi all welcome to the jenkins online meetup. Today we have a demo session as a part of uh jenkins, ui, ux, hackathon and casual will present a prototype of the github checks, api plugin for jenkins. It's a part of the google summer of code project, and this is just the beginning. Our coding phase starts next week, but still there is a good prototype and let's see the demo and let's discuss it, the floor is.

A

A

Would you like to share the screen? Yes,.

B

So I start here on my screen now, so can you see my screen? uh Yes, okay, so hello, everybody, I'm koji! Currently, I'm working on this github checks, api plugin for this year's google summer code project and this uh this project is still in design during the community bounding period. um Well, official startup, the coding in the beginning of the june. So so today I'm going to show a prototype of this project.

B

Now um I'm here to do this presentation, because I want to invite more people to join us to tell us what you want to get from the uh from this plugin and and which will uh what the api looks like you want to see, and that's it so uh so here so this is today's I'm going to talk about so first. I think we should start by understanding how the current drinking- how currently jenkins is interest, reacts with interacts with uh github.

B

So, let's open the service, so let's open the pr for now. This is.

B

So here this is uh the prs for the jenkins master, and so let's open up appear here, just for example,.

B

And currently, if, if you use a thinking, that's ins, the integration for github you'll, see there are some checks reported from jenkins, and uh currently this is achieved by using the status api and this systems. Api can only need one message for each first check. So if you want to take a look at the details, we are going to the uh jenkins instance website, and I think this is a you're going to the blue ocean plugins page.

B

So here it is, and but the checks api is is different. It can do more so.

B

It will report the status as checks and you will see more information, so here, for example, I created some checks by my plugin earlier this day.

B

So if you, if you want to see more details, you can just stay on github, you don't need to go to the jenkins website and you'll see the checks here.

B

These checks are created by my prototype. Currently I would haven't uh provided any information besides the names so and the conclusion so.

B

So, let's start so, let's talk about the checks.

A

B

uh You see the picture here uh if we, uh if we eventually end up in the this plugin, will able to report the wording, some like code coverages from the jenkins to github, and it will add some annotations for each line of code. You'll say some annotations like this. This is something we want to achieve. Oh in the end.

B

First, so before you create check, get up checks, you have to convert the jenkins into all the guitar maps. I think this uh team has achieved this in the gap branch source api. I think the plugin that you have french source plugin. Yes, I use.

B

B

So it has helped to.

B

Sorry this is guitar, let's kill that.

A

Yeah, this is the right uh plugin yeah. I have also posted a link to the announcement blog post in the chat.

B

Okay, so here is a team implemented this get out of authentication guys. So if you want to create checks, we have to convert jenkins into a getup github app and here's something you need to do so if first, you have to create a github app here- and you can see here with some permissions to access to my repositories, and here I install this and app into my the sandbox repository and if you want some settings.

B

Here's here you have to set the webhook to your jenkins and normally it's normally. It's like.

A

B

So, okay, here so normally it's uh uh the the web hook to receive the github events. uh Is this the is this web hook and don't forget to please to add this backslash? I remember I did a debugger for hours because I just forget to add this backslash.

B

So that's about cleanup apps here, I'm using the uh in order to let the github access my jenkins, I use, uh I use a forward delivery on tool to send the events to my computer. So this is the events I received during the.

B

So questions plugin will expose this check. Save package originals file. Yes, currently the get out branch sword has done something like you see you see here, okay, I.

B

B

I think team has achieved some part of this currently use this kind of url to create check rounds for now, but eventually we'll add the pipeline support for our plugin.

A

So this code will become just a single step or maybe we'll even run automatically like it currently happens with status. Api yeah. Thank you. I know that code, it's it's mine.

B

And, and- and I won't say that here is something I want to get more- our information from the users because you can see now, uh if you want to configure the checks in this changes file, you have to just set this safety taste.

B

If you want, if you want more, you have to access the reports from the other junkies plugins, like the warnings, plugins code coverage plugins in order to report these informations to github. But if you can't access this, these plugins reports in the uh the the jenkins file, maybe you're, just able to create the chakras.

B

That is something uh where our my team is still struggling with.

B

So next I want to talk about the design of my plugin right now and so yeah.

B

Most importantly, there are three parts and three uh dependencies, the the plugins that my plugin is dependent on and the first one is the github branch source api. We have to use this the scm api implemented by this plugin to retrieve the the sources which we use, the xiaohan branches of the jenkins job and the github github plugin is something we used to use to like receive the events.

B

Since this plugin has implemented extension point, we just need to extend that and we are able to receive that it can have events from yeah. So.

B

Here is uh the design of currently, or so mostly. Most of the works will focus on this job listener.

B

This job is class, so there are three stages of uh king king's round. Normally, here is when the github um creates the users create a new pr or comment either with trigger or jenkins to start a job and when the job enters the crew and where our our checks, our our plugin, will enumerate the consumers to create check rounds and we'll set.

B

Those check runs include um we'll talk about this uh in detail later, uh when we, when I'm going to go when I talk about the code and later when this job leaves the pre and the stars.

B

Where else you also enumerates the consumers and to update the check rounds in progress and eventually when the job completes will enumerate the consumers to complete the check runs, and at this point we are also to collect the reports from other plugins, like from the warnings plugins from the coverage plugins to get the reports, and then um we send these reports to github and user will see them.

B

So so, let's here talk about here, I'm going to talk about the uh api we're going to provide. So you see here this, this uh checkround results extend the extension point and so any any plugins. They want to report the informations report. The wordings to have they just need to uh you just need to extend this class, and so here I I draw some consumers possible consumers of our plugin and each of the customers will create a single check wrong. Like for warnings plugin, we created check, run for warnings plugin and for code coverage plugin.

B

We created another checkpoint for it. So next.

B

So so now I'm going to show how the how the prototype currently works.

B

So yeah I create a repository as a sandbox to to taste my plugin.

B

I create a pr aria and there are some checks, like the default jenkins.

B

Okay, so thanks all uh so here we have two check rounds in the same check, suit and you'll see here. There are two check around because uh I extended extenders from the uh sorry for the name. The check round source is is a is the general result. I haven't changed the name yet so so in this. In this extension point we provide. uh We just currently add some abstract uh functions as like get link, get output actions and we like, like defer the the conclusions from the build.

B

So if it's better or could you success, then, and we get the conclusion success so and also we I in this uh in this default uh setting. We also create the time when it's complete.

B

So yeah I'm going to.

B

So next I'm going to show how this actually works.

B

So here when I start use the this, uh normally it's well. The build will trigger by the guitar prs. But uh uh now I just uh I I just use the uh click. The button.

C

Here in the genghis website.

B

And- and it will show here so this function is uninitialized. uh We because we listen to the we extend the wrong listeners were able to all be triggered when the when the uh jenkins job starts so on initialize like like it enters increase, we creates the check rounds into into q state. So here we go. We just here. We just retrieve the headshot of the of the repositories, and I also can get the repository names.

B

So here we have to create the token and in order to access the github apis.

B

So, in the after on creator token, the next thing we do is to enumerate the extension from the check resources. If you see here, our first source is default, is the default checker source and in the default source we just provide the name um of the check checker. So here we created sorry some network problems.

B

There's some problems, I'm struggling right now, uh because uh if, if the message just sometimes, I think I'm bad luck today, so this just never mind. I started again.

B

The the access to github api sometimes fails. I don't know why now uh there's something I'm struggling to solve now.

B

Let's see again, let's try again.

A

Sometimes eps just work differently in the debug and common mode, because debug instrumentation creates a lot of delays so for some libraries it's enough to cause issues.

B

C

B

In the first, so yes here we create the first strong. So if we take a look at the the checks page here, you see, this defaulting is wrong. It just started 14 minutes seconds ago, and if you go to the conversation card and see here, this checks is just incredibly keep going. Oh bad luck.

B

Sorry, but we just keep keep moving for our this single check run. The logic is basically almost the thing. What's the difference is in when the job starts. Instead, we said the we set the proposed to choose state.

B

Now we are going to set the join, the check runs to in progress state and we are also adding started at a time so you'll see so you say here.

B

B

Time here is on the job starts.

B

Let's create the token and also update the check.

B

B

Okay, so you see here this there's a circle rotating around it and.

D

B

Have conversation card.

B

It's in progress now.

B

So if we keep going and now we are going to complete the check round and complete the check round here, we just use some static like set of status to be completed, and here we just set the conclusion for success for success, since it's just a prototype for now, but it will maybe make these parameters to be configurable by the consumers. Vlogging.

B

Let's see if there is stuff.

B

And so I guess we'll stop people here, and the next thing I want to talk about is uh the parameters we can. uh We can provide for uh his offer for github check around so.

B

So when created check around you can provide this parameters um for now in my plan, I'm just going to split these parameters in three groups, something something is non-configurable by the consumers, like the like the uh headshot, like the detailed urls like the status or start at that time.

B

We'll do this for our customers and another group of the parameters is the configurable ones and like the copy group ones, I mean uh like the name of the check round uh where we should allow the consumers to custom the name and also maybe some other things like the lacking output objects and the title: the summaries of the of the report, the annotations of each lines of the code. uh These things we need to you know retrieve from the consumers, so this part is uh configurable.

B

Another part, I think is, is also configurable by the users, but will provide some default settings. um So maybe the conclusions if the users didn't provide the conclusions for their our reports and then we'll maybe just uh defer the the conclusion from the uh jenkins job the status.

B

So yes, that's a that's basically uh about the prototype now. So so any questions about this.

A

Looks great thanks for the demo.

A

One question I had is about dependency on the github branch source, so do consider moving the um yeah about notification, support outside of github uh branch source or they plan to keep it there. Let him.

B

I'm sorry, I've been quite understandable.

A

Yeah so um github checks. Api plugin currently depends on the github branch source plugin.

B

Yes, it's uh we have to use this github branch source plugin in order to retrieve the headshot, because this has implemented the scn api. So I think we have to use it. Does it answer your question.

A

Yeah it does so. I was wondering whether the plans to detach that for the plugins but yeah. If not, I think that it's a great thing anyway,.

B

Also, there's another part that we have to depend on the github branch source. It is, uh I think I mentioned earlier. Is uh uh we don't need to? I guess the the branches has implemented the app has implemented this app authentication part, so we just depend down there to use that part.

A

Okay, thank you. Okay, any other questions from.

D

Others uh hi. I had one question: uh okay, so uh casey, uh so uh I I was wondering how the implementation has been done. I mean how is jenkins reporting uh the github uh checks. Api like is it is. It has, has to be specifically mentioned in the jenkins file, or does the plugin automatically handles this.

B

Yes, I okay, I think my mentor has has opened a draft pr for this.

B

So here's some- you know preview of this of this api. You know so like uh here. um If the so we we should assume this class has extended the the treatment results extended, our our extension point. So when the jobs when the job finishes, uh it should have said like said the status, says the cheques and send the summaries and ending them and also check the other tape at the annotations.

B

And, oh I'm sorry, I should uh sorry I I I started all the working. um So there is some check wrong results right. So, first, when the jenkins job starts uh we'll attach these results to the round through this check run, result action. So later, when other plugins, I have something to report, they can just get this action from the wrong um by just the get action function and the method, uh and then they can, they can get the result, parts from the action and they can do something changes in this wrong result.

B

So and when the job completes, we just invoke those methods like get annotations, get output and, and then we just report them to the github. So that answer is your question.

D

uh Yeah it does sound. uh Okay, that's that's also cool that uh it can be extended and modified, etc. uh Like uh from the users of gitlab brand.

D

Code manager, scm uh is um like the stages of their uh stages that they have defined in the jenkins file. Like suppose, uh there is uh two states like like build and deploy. uh They want two stages in their uh like scm. That says, build has passed and deploy, I mean and all the details related to that. So uh so suppose uh this is the scenario that I want like. I want the status of build and deploy stage, so it do.

D

I have to mention it in my I mean do I have to specifically write a build step to I mean a pipeline step to uh provide the scm. uh The status of that particular stage or plug-in will automatically handle that.

B

um I think most part if the for the consumer plugins, uh I think like like for the awareness plugins uh after the like in the build step, there were some unlike in the published step. They should you know, report this uh report change the uh some properties in this class, and uh so literally we when we invoke these methods we can get, but in the pipeline uh in the pipeline in the jenkins file.

B

I'm not sure we can achieve that because if, if we want to report the uh report information to github we have to in the in the pipeline, you have to provide uh some wordings and some wordings in the pipeline. But if you can't- and you can't access the wordings in pipeline and then you can report it to our our our plugin, then we can provide it to uh to the github. So the pipeline support will still discuss with my mentors whether we can how we can support the pipeline and whether we should support the pipeline.

B

So I'm not sure whether that this answers your question.

D

um Yeah again, somewhere does uh so um like all the uh checks uh result sent through github is done by plugin automatically like doing uh running the job it sends uh started and finished or like other results, so is it done by plugin itself, or that has to be mentioned, needs to be mentioned separately in the jenkins side, like you had written a curl command in there, so we have to specifically mention it in the jenkins file.

D

Has implemented it's mostly for in the like for the job like when the job started and when the checked out uh like for sem on checkout and etc so uh like it would be nice if there would be listener on each stages and reporting on that. So I was also wondering how is it doing that if there is.

A

B

A

So, let's wait for the catcher, he is able to answer it live. If not, we will just.

A

Take it offline in the chat. So meanwhile, if you want to know more about this project or if you want to join that there is a mailing list, we do it as a part of the platform seek at the moment. The results chat on guitar.

A

Where you can find all the information and when you can chat with mentors and use other stakeholders of the project and if you want to join the meetings, there are weekly meetings on wednesdays. So you can just join the project meeting and see the recent demos and to discuss the status.

A

A

So okay, should we uh take the question offline.

C

Yeah I mean we we can do. I think, actually, um like purges questions, uh answered a lot of the questions I had as well. I think um what I'm missing kind of is like an overall. What's the overall workflow like there's a lot of technical details here of implementation, but I have similar questions like: what's the actual, what would a consumer? What would a an end user of jenkins?

C

How would they use this um like? If I install this plug-in, will it magically start reporting my warnings from the warnings plug-in um as those steps happen? It's just that kind of workflow and kind of, like example, jenkins file and that kind of.

A

Stuff yeah, it would be a great addition, uh so there was some items about that mentioned in the original proposal.

A

So, if you're interested to know more information, you can find it here, but yeah it's a proposal which is draft and obviously we will see what will be supported as a part of jsoc later. But here you can see some deliverables uh there and I believe that it was discussed. uh What kesha wants to implement, specifically- maybe not.

A

Maybe it's not discussed today in details, but in such case you should definitely go to the chat and bring up this question, because it would be a great feedback to the project team so that they can decide what way they answer. With this question.

C

A

Yeah, so let's just take it offline, because yeah definitely catcher has connectivity issues so yeah anyway, thanks uh for this presentation, because it's definitely a great demo and it provides a lot of information about what's been done in this project and yeah, everybody is welcome to participate.

A

Oh, does the audio work for you now.

B

Yes, I think please.

B

So that's everybody was leaving.

A

Some people left, but we had a discussion and there is still open question from chris, which you could briefly answer. How do you plan to implement that? Would it be automatic reporting or would users need to add steps to get the checks reported.

B

B

But that depends on okay so, but that depends on the on the how the consumer plugins implements on our extension points. So that's uh that's. It.

A

Yeah, have you already discussed it for code coverage, api or forwarding cng plugin.

B

Yes, and what for the warnings plugins, just like, I showed the pr opened by wooli and about the api here, just going to use the way I designed like I attached the results through a round to the attach the results to to the run through action, and uh so during the build steps. All the plugins are able to access this action and so that access they can access the results and change some properties in their results. And we can retrieve the results and at the end of the job.

B

And then we report it to the github.

C

A

C

Yeah, sorry, I was just it's maybe a kind of low-level jenkins technical question um regarding that design. I'm wondering uh if it's possible for a plug-in, for example, warnings or whatever is it possible for them to create an action and then another plug-in, like the github check, plugin to automatically notice that that action has been created like it connect listen. Can I plug in listen for actions being created on a run um because.

B

I'm just wondering.

C

If there's like um yeah, if you have kind of like a decoupling there, where you don't have to, uh I don't know it's just a bit simpler, I don't know perhaps yeah in principle.

A

It's possible and I'm also not sure whether there is a good api for that right now, so you can always connect to a saveable listener and get notifications when the metadata gets saved.

A

But yeah, let's just take a look at the current uh runway scenario implementation. So I guess here there is no step for action created so but the if would say use case we could probably add one or maybe there are other apis which support that.

A

But here on the low level, you can just connect to the saveable listener to capture this data. If the, if the action is persisted.

C

D

Casey, what's the plan for this plugin like it would just be providing extension points for other api plugins to report like the checks to github or the checks? Api default would be doing some sort of reporting as well.

B

Okay, can you repeat your pressing and not quite understand, okay.

D

So, uh like the checks, api plugin would be by default, doing some reporting to github, or would it okay so like? Would it only be providing extension points or would it also be doing some default uh reporting? So what what? What are the default reporting that you are planning to.

B

Yes, the the defaults, uh the default parameters are like the other started at the the time when the job started at and maybe the status it will provide defaults at a different stage of the job, so it provides the default like code in progress and completed and so and some other things like the conclusions.

B

If the the consumer plug-in team provides a conclusion, then we will get this conclusion from the uh from the jobs results and, like the job council will outset the convolution as cancelled and if the it fails and we set the calculation to be failed. So that's uh is currently about the about the people's configuration.

D

B

So are there any other christmas.

A

It's like not so yeah thanks a lot for the presentation and thanks to everyone who participated, and uh it was an interesting discussion, uh we will post the recording on youtube.

A

I guess today tomorrow I will try to clean up some uh um there. While we were handling this network issues, but the video will be there and, if you're interested to know more, please join their project channels and I believe there will be a lot of interesting news there over the next few months.

D

uh Great work, easy all the best for your coding period.

A

Plus one thanks all right I'll stop the recording.