Jenkins Documentation Office Hours, 7 Jun 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: 2021 06 07 Docs Office Hours

Description

Jenkins documentation office hours generating the Weekly Jenkins changelog

A

Awesome all right welcome it's the 7th of june. This is documentation office hours. Remember we abide by the jenkins code of conduct, so dhiraj. One of the things that I was hoping for was that you'd be willing to try another time to create the weekly change log. Oh I'm gonna turn off my uh camera. We don't need to watch me.

A

Are you interested in doing that again or is there something else that was more important to you for us to do tonight?.

B

Well from my side, I am comfortable with anything that you think should be of more priority.

A

Well, so I would love to do one more time, the run the weekly change log and have you be the person who submits it, because that way, if I'm not available next week or the weeks after that, we could still get a weekly change log.

A

I, when I brought this to when I brought this to the jenkins governing board. There was some skepticism while we're not sure that and someone who's, not an experienced jenkins core developer can actually maintain the create the weekly change log, and you were great proof last week that, yes, somebody can.

B

Yes, definitely I'll prove them wrong.

A

C

I'll try my best definitely.

A

Okay, so if just.

C

Anybody could do it, somebody with some talent well, thanks.

D

So should I share my screen? Yes, please, if you could sure, and is there any background noise that is.

A

Even if there is it's worth it, let's just go ahead. That's great! You just leave your your your microphone on and we'll we'll talk to you and ask you questions and let you answer. While you're sharing your screen awesome.

E

So I think you can see my screen.

B

I'll just trying this.

F

Right now so, okay.

B

So we are at jenkins core directory and we want to run the docker command. But before that last time we were.

A

So are you, are you up to date with the current version? That's on the remote on that's on the on jenkins.

B

Exactly so last time we did that we ran into some problems, so he suggested me that there's a file in which you need to change the version. The latest version, so from that it will be fetching all the pr's.

A

Well, actually, even before that, your jenkins core, the the the I think, the directory in right now is the jenkins directory right. So here, if you could do a git log, let's see what where where it's at, and let me double check to compare that it's at the correct location.

A

So when I look at mine jenkins, core is okay, so you are so you. It looks like your cup, your local copy of jenkins core needs to be updated.

A

And so what you're going to need to do is quit out of the out of git log and do a get pull minus minus all.

A

Okay, now you need to do a git, merge upstream, slash, master and there's actually a another command you could use instead, but this one will now bring your local copy current with what's on upstream and now, if you do the git log, it should show something about sshd core. Yes, it does good okay, so your so jenkins, jenkins core, is up to date.

A

Now, if you'll, if you'll, do it one more step, do a git space push.

A

This will push your merged master branch to your fork. You don't strictly have to do it, but it's I like to do it just to remind oh now you have to remember your username and password.

D

A

Super okay, so so now your local copy of jenkins core shows all the latest changes. So now you should be ready to run that docker command.

G

E

G

B

So this will take up all the prs that has been.

A

Right, it should oh, no, what's it saying: okay,.

A

Interesting, okay, that seems like the correct that is the correct version. So why is it saying no url specified docker run curl no url specified.

A

Okay, we may have to have you stop sharing?

A

uh Let's have you stop sharing your screen so that you don't show us something we shouldn't see and then.

A

Now, on your local command line, instead of just the docker run, put the word echo in front of it and see what it's outputting as your github underscore off. It should be a username.

A

I think it usually a username, a colon and a passphrase or a a token. You know, so it should like look like a username password. Does it.

B

No dash v and then the location of the workspace dash, dash, rm and then location of code generator.

A

huh Okay, so let.

B

Me set my github, I think.

A

You may not have a value assigned yet for github underscore auth, but but we ran this last week, so I mean it worked last week, but you may need to define the github underscore off environment variable.

A

And let me double check, while you're doing that, I'm going to double check just to be sure that github isn't down, because there actually are times when okay, it's it's working! Okay for me, so I think it may just be that you don't have a value for github off.

B

Okay, now it has a value.

A

Okay, great so now you can start sharing your screen again. I clear your screen so that we don't see your github credentials. We don't want to record those. That's none of our.

A

H

Yes, so we will.

B

So I cannot even go up now.

A

Oh okay, so well so the if you look in the. If you look in the readme file of the of the the generator, it's got, the exact docker command. You need yeah in court, changelog generator in the.

A

A

This exactly that one well or or the one above it, you need the one that one is fine. You just have to remove the number off the end, the one that your icon is over right now is the one.

A

A

Yes, that's what we're looking for good, okay,.

A

Okay, now that's a fun one.

A

A parse error: hey, could you do an echo um dollar sign lang?

A

Space dollar sign lc, underscore all. uh Oh, it's capital! It's all! Uppercase.

A

Dollar, sign, lc, lc underscore all, uh and I think that's it yeah. Those two enter ah yes, okay, so, and they might be okay, but could you instead do export space lang equals.

A

En underscore capital, I n dot utf-8, where the utf.edu dash 8 is all caps.

A

Yeah and let's see if that helps english has spoken in india using the utf-8 character said: let's try it.

B

So I'll run the command once again.

A

Yeah and now your arrow key should work.

A

Yes, okay, that's better! So one of the problems I had found in the past was that that docker image for some reason, one did not have utf-8 as its character set, and so I think that's what you just did is you've now used the correct character. Character set good okay.

A

So we have the the template.

B

Yes, so now we'll go to the inside website and open up their weekly.yaml file.

A

E

B

Edit here only, what do you think using nano, because.

A

B

We had some problems last week, yeah.

A

Vs code really surprised us, so you're welcome to experiment with vs code, but I think I think it's more aggressive with its formatting of yaml, then we're ready for it.

B

Sure so what do you suggest? Where should we get the files.

A

Yeah, so so nano is great if you're comfortable with nano, whatever editor you're comfortable.

A

I

I

A

A

E

So this is change log file that we just generated if right, move forward, alt dot.

B

Yes- and this is the v35 that we want to generate.

J

Right so so, yes, please.

A

Yeah now I am not. I am not a nano power user, so this will be a very interesting experience. So I would assume you move down one line and do a control k, a bunch of lines.

A

To cut the text and then you go paste it into the other file and then we'll edit it in the other file. Oh it won't. Let you probably won't. Let you cut, will it oh, no meta a there. It is yeah, look meta, a marked text.

A

Oh this one or meta6 yeah, so meta six is copy text right, so meta a to market and then meta6 to copy it.

B

I'm going to ask a very silly question: what is this oh.

A

Meta means the alt key, sorry yeah, that's a that's an emax damage yeah, but but your technique that you're using now should be great.

A

Now, if you can switch to the other, the other buffer and so copy that, with your editor done.

I

Then we're gonna paste it here.

A

Yeah, I think so now, where are we in this editor this? This is okay, so there.

B

Should be a very long file right.

A

There should- and there isn't- okay- so maybe it's time to close this: let's go back to vs code, you're comfortable with that, let's use vs code and we'll figure it out. I mean, let's not put you into some strange and bizarre editor. Let's get you into into something that's comfortable, okay,.

A

B

It was last week we were not able to catch the difference right. The yeah we'll find the vs code did on our ammo file. The full jungle file.

A

Well, but, but I think, let's just see if we can figure it out, because ultimately you're you're comfortable using vs code right and lots of lot, many many users, edit with vs code. So if vs code is going to do damage, we want to know how what we need to do to make it.

E

A

B

This is the weekly ammo file that you want to make changes to.

A

Yeah, this looks.

B

Great the template that we just created.

A

Now, we'll probably even after you get the the file in the editor, we'll probably want to go check your jenkins.io, that it is current.

A

Okay and yeah you can yeah, you don't need to save that modified buffer.

A

So here from your shell, we want to go to the jenkins.io.

K

A

Yeah so do a git pole, minus minus.

J

J

A

And get space status will probably want to just throw away local changes for the moment yeah. So I think what you want to do is say: git space, merge, space, minus minus abort.

A

Abort a-b-o-r-t.

A

All right so now get space reset space upstream, slash, master.

A

Oh now, that's interesting: why would it have unstaged okay get get status? This is interesting.

A

Okay, so get check out dash dash dot space dot. uh Sorry, you need a space after the dash yeah enter now. Do the get status.

A

So what we're trying to do is get this to to match with upstream now we want to check out a different branch: let's check out master, get space check out space master.

A

Sorry for that and get reset minus minus hard.

A

Space upstream master, so what we're going to do here is make your local copy of the master branch exactly match up stream. Okay, now do a git.

A

Log: okay and yes: okay, that's good! So now, and now, if you just say for your own benefit, you can say: get space push space origin.

A

What this is going to do is make your your private, your your personal copy, your fork match with upstream.

A

Good, okay, all right! So now we need a new working branch, so get checkout minus b.

A

And change log dash.

A

A

All right now we're ready to go back to vs.

E

A

Okay, so there's this is the prototype and is the weekly.yaml that's on its left. Also, oh yeah, very good.

E

So this is the change.

A

Yeah, so what we want to do now is take the the text, that's in the top and do the same edit. We did last week to transform it into the bottom oops that you just move the comments you want to put it after those comments, because it's a new one, exactly.

E

Right changes into first step.

E

Paste it and change the version here.

A

A

And because that looks like a number it needs to be in quotes, so it needs to be either single or double quoted. Yeah double quotes are great and then the release date will be it's tomorrow. Is the eighth? Isn't it yes or.

H

A

Is the eighth for you? Yes, so so the eighth is the release.

B

So I all that work is done now. We need to start working on making these messages right.

F

Exactly right, very.

H

Good, so it says.

E

I was ignoring this change.

E

Race conditioning.

A

And for me, that's a good enough description that really yeah. I would take that again. This is me that that admitting, I know who jesse glick is jay. Glick is a very, very frequent um author and he writes very very well.

B

So whenever I see jesse click and daniel pick, I just need to close my eyes and just.

A

Exactly that's that's been my approach anyway, is when I see anything from daniel or from jesse, I just close my eyes and accept what they've got now. This one does have something to teach us here. You see the characters surrounding the word. Linkage error they're. That sort of backwards quote those need to be transformed into an html code tag. So a less than code greater than.

B

Similarly, how we did last week for no method error, something yes.

A

Yeah you're right- I didn't remember, we'd done that last week. Yes, that's right! Okay, ready to go to the next.

A

B

So this is a bug and first one was also a bug, so they should be at the top above rfb. Okay,.

A

Yeah, I don't remember which order that's a good question. I'm gonna have to look at the style guide to see which order the style guide says you keep going and I'll look up. The style guide.

E

So do not change fonts when artifacts are shown as free.

A

Yeah, okay, so so this is one where we may want to beg for meg or kristen's help. I actually like the pr title better than the better than the proposed changelog.

A

It says: do not change fonts when artifacts are shown, as I might see it as a tree.

L

Yeah, I almost like the pr title better too yeah.

A

So so dhiraj I would keep the pr.

L

A

It's more of a sentence.

L

Yeah- and it's also, I think it's not yeah just like yeah, it feels weird to say fix here, but yeah, I don't know I I kind of like it.

A

Sure, and now one of the things you need to do there is be sure you end with a hard stop with a period.

F

Great so there's two and then.

A

I'm looking up the style guide.

C

um While we're picking at pros in the previous one remove of commons digester from core, I think the of could go.

A

Oh yes, yes, yeah.

G

K

That's the one he's working.

A

C

J

B

So, which one are you suggesting.

A

She's she's saying keep the keep. The proposed changelog, remove comments, digester rapper and delete the pr title: oh okay! So oh now oops there was one item there did you see the developer colon? We want to retain the developer colon, because this is a developer specific fix that end users won't perceive.

J

A

Right and and that one you can tell because the category rfe or the category is developer now, there's an indentation change there, dhiraj that you may need to correct.

A

No, it's! Oh yes, it's different in your destination buffer than in the source. Interesting is that visual studio code doing that for.

H

Us, yes, totally.

J

E

E

B

And then for these, as.

G

A

ah Okay, so there you have a block, indent and out dent facility in visual studio code.

A

Nice that that looks right to me, okay, so developer, remove commons digester wrapper from core and dependency entries.

G

J

Okay, so this is bumping and.

B

For this user suggested that some of the details regarding bumping from this version to that need not to be shown to the users, so we need to search in the file whether this specific thing was previously added. As a comment or not. If it was added as a comment, then we put it as a comment again as well right.

A

Right exactly so, look look for this one. I think this one was mentioned. I think sshd has been mentioned very prominently recently, and so I think this one will need to be mentioned. Yeah. Yes, so it has been mentioned well keep looking, because that one is actually, I think, different.

E

Yeah, no, this one isn't just recently.

A

Oops there yeah, so so we've done one case where we didn't mention it and scroll down down one. Oh there it is so this is. I would keep this one because it's been a source of a number of recent changes, so I think we should keep.

B

It so the title should be this.

A

That's what I would take it, as is just take the pr title. Let me double check just to be sure that.

A

A

Yes, okay, let's take a look at.

A

A

Five: five, four seven.

A

Okay, yes, we've got several approvals, so let's include it: okay, good.

C

um Syntax would it be better to say bump ssh or ssh decor from 2.5 to 1 to 2.70 in jake and cli.

A

Oh yeah, good, yes,.

C

I think in jenkins, cli should come after the release numbers right, good.

G

C

B

So this looks good right.

A

L

Yeah, I think that sounds that sounds right. Okay,.

E

So this was about the last one and then we just need to copy all of this.

A

Just copy the comments.

A

Now we have to do the investigation.

A

It's it's they've used bump before that's a an a generated word used by dependabot, and so we've usually just left the word bump in there.

A

All right now, the challenge.

C

A

The challenge now is to figure out what the diffs look like to see. If it has changed the the file dramatically, can you save that file? Let's go out to a command line and do some some differencing.

A

So, do I get space.

E

Different, I think I need to do this.

A

That looks good yeah, so we would, it would be nice to get rid of that trailing white space, but it doesn't, it doesn't look like it reformatted the rest of the file. So that's a that looks like a big win.

B

So it is suggesting to like there is no express space.

A

Interesting there's no extra space, but it's have you saved the file.

I

A

Try the diff again, let's see oh okay, now it did the rewrite.

A

Okay, so now, how do we teach visual studio code not to do that kind of massive rewrite of the file? Any let's see, maybe you do some searching I'm going to do some searching. There's. Probably some configuration vs code do not.

A

G

A

A

Oh wait a sec. There was, it said something about turn off, avoid reformatting save. Oh, oh, look there. It is command shift, p, save without.

H

E

E

A

Is probably alt.

A

Save without formatting control k s; okay, now that it saved it. Let's try that diff.

A

A

Well, I guess I I guess we could always save just the say, copy the file to a separate location, reopen a fresh copy of the file and copy just the last block and then save.

C

A

But I thought that when, when diraj did it that he that the command became visible on screen, so dhiraj try doing that save without formatting again it may be that the files already been modified in in memory.

E

So it was command shift three and save without formatting.

A

Right that one.

E

C

What did it say, command, alt, p,.

C

Yeah, that's so am I.

A

So my proposal- let's have you copy the changelogs weekly.yaml to a temporary location and reset it and we'll just bring it in from the.

H

A

Yeah put it someplace safe on your desktop or wherever it's comfortable.

A

And now you'll go to your command line and we're going to or you could use vs vs code as well. We're just going to ask git to reset the file so from the command line. It would be git checkout.

A

Dash dash space dot.

B

So, do you want me to do it dominant yeah,.

A

Terminals easiest for me. I know it can be done with vs code as well. I just don't know how to do it so get checkout.

A

Space dash dash space dot, so what that says is please check out any files that are currently modified and make them match. What's on the remo on the in the repository, so this is basically a reset. Now, if you do a git status, it should say is tell us that nothing is changed.

A

Now we go back to vs code.

A

Reopen that file it may have already detected that it's changed.

B

Okay, so you want to open the same file.

A

Right, open the copy and we'll paste its contents into the into the original.

E

A

And then, then, when we save the original, we will be sure we have you save it with file save without formatting.

A

Okay, now, let's try that file save without.

E

A

Okay, now there's still maybe a formatting problem here, because I think so now, let's do a make, run and see what it says, because I think the indentation there is still a little surprising to me.

A

Sorry, dhiraj that this is so complicated. Thank you for being willing to do it.

B

Yes, that's my.

B

B

So about the last time when I submitted.

B

There should be rfes between major bug and another type of change, which was like there has to be some gray colored changes between the two red color changes for visual uh easiness.

A

If, if they're available, yes this one, I'm not sure there will actually be any available. So that's that's why we want to look at it visually here, so open it up in your browser and let's see what it.

A

A

A

Okay, go back to the terminal window, let's see if it's reporting an error or some surprise.

B

You can still hear me right.

A

Can hear you yes.

E

A

Well, it's certainly it's doing a lot of work generating this the website so.

A

Okay- and here comes the site.

B

And today, when I woke up, I was ready to go through the last week's video on youtube, but uh I I don't think you uploaded that right. Oh.

A

Didn't I I thought I had I apologize, I will I will get that uploaded. I should have done that. I uploaded two videos earlier today and must have missed the that one I will get it done.

B

Yes, because I was trying to practice online, so that's why I was looking for it.

A

Right well, and that would have been a great help if I'd done what I should have done and and had it available for you.

E

A

Oh there it is nope you're right. I had not uploaded it. I see it right. There.

A

It's very slow now, okay, and this one is showing us that we need to make that change to that file, notice that it says 2.296 when you click the change log. I bet it will show us a change log for to only 2.296 and we just wrote.

B

Are you to see the change lock screen.

A

Yeah so now it's generating the change.

E

A

Or did it fail so switch? Oh, no! It's coming still.

A

A

Right so it's showing us 2.296 and we need because that's the most recent actual release, so we need to trick it by show having it show us the next one, by changing one of the files on the disk. You remember which file that is, there's a file named version, something or other in the content underscore data. I think it's underscore temp directory.

J

Yes, I I'm trying to switch to terminal now and it's very slow right.

J

Would it help if I just stop generating the website for now.

A

It will because we'll need to stop it anyway,.

A

We'll have to regenerate it after we update that that.

A

B

And wow my time is also stopped.

A

Well, but it's still, it's still delivering audio for you and I'm still seeing the screen.

K

K

Yes, so stop the website.

B

Now the file that you're saying is in.

A

Yeah, I thought it was, let's see so.

B

B

A

Just a minute- and I can I can get you the exact name, it is content, slash underscore temp, not underscore.

A

Data so content, slash, underscore tmp, slash latest core dot, txt.

A

And it's tmp rather than t-e-m-p.

A

And the core there will be has a capital c in.

E

A

Well- and you could dhiraj there's another way, you could do it. We, you just say echo space, 2, dot, 200.

A

202.297 was that what it was was the number version we're working on? Yes, yes and greater than so redirect the output to that file named.

J

A

It's not slash content but dot, slash content.

A

And now, if you press tab there, it should complete it for you.

E

So that's done.

A

Okay, now do the make run again and let's see if it, if it will, let's show it to us this time.

A

Go ahead and type make run.

J

Okay, I'm having some delay.

A

B

Okay, I'll type make them now.

B

Oh, it's very slow now.

A

Maybe you want to stop sharing your screen that may make your computer much faster. Why don't we? Let's? Have you just stop sharing, because you know what to do now?

A

Yes, so let's just have you stop sharing your screen and that way you get your computer performance back.

E

I have clicked on stop saying: let's see.

A

I'm gonna stop your sharing. Yes, please, okay and then I'll stop my share oops. I still see your screen shared, so it didn't appear to have stopped your sharing there yeah. You should see a blank screen for.

A

A

That's weird: it keeps going back to showing your screen.

A

Stop participant sharing there we go yeah. I have a. I have a control on my side that tries to do it. Okay, hopefully soon you'll get you'll get your computer will be faster. Now.

B

Diraj, it is a little bit slow, so it's taking time it has stopped starting.

F

E

Now I open the terminal and run maker.

B

And execute the command maker.

A

B

So already 8 27 I'll try to do.

B

B

A

So is it, is it not arriving.

E

A

Okay, well, let's, let's wait.

A

I've got another meeting scheduled to start in just two minutes, but I hope we'll be able to finish this and I may just tell the other people that I'm going to be a little late for their meeting.

A

Because we're so close.

E

B

But just in case it it doesn't happen, it takes a long time. So what do you want me to do? Should I submit the pr and the photo of it on the pr message and then you can review it? Maybe.

A

Right, you could, you could submit the pr if you submit the pr, even without us, having seen it you've already done quite a bit of help, and- and I can look at the pr and do some reviews online after this other meeting finishes. So absolutely I I mean you submitted the last pr, no problem, so I think diraj, if you, if you're willing to do that, submit we could call this meeting done and I will I'll review the pr asynchronously with you after after you've submitted it.

I

I can just speak better because you value every one of us. What about the.

A

Minutes for this meeting we didn't open.

I

A

Oh, we did not you're right meg. I should have made some notes. Yes, would you be willing to.

C

This was good, we could just know who was here and what we did.

A

Exactly yeah, if you could, let me would you.

C

Like me to do that.

A

If you could, that would be wonderful.

C

The link's not.

A

But here I'll paste it into the here is the the I'll paste the link to the minutes into the chat here. So there are the meeting notes. Can you open those notes? Meg.

C

C

A

C

There we go, I got it.

A

Excellent, so, even if all you can do is propose a revision there. I can then accept the change and and we'll have notes.

A

So dearest you're, okay, submitting the pull request on your own.

B

Yes, definitely that would be actually better considering everyone's time.

A

All right, thank you. Everyone dhiraj thanks again for being willing to work through this. You are heroic. Thank you very, very much.

I

Great work, dear raj, my pleasure.

A

Okay, I'm going to end the call and I'll upload. I promise this time. I will upload two meetings.