keptn Developer, 17 Mar 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Keptn Community & Developer Meeting - March 17th, 2021

Description

Meeting notes: https://docs.google.com/document/d/1y7a6uaN8fwFJ7IRnvtxSfgz-OGFq6u7bKN6F7NDxKPg/edit

0:00 Welcome
5:07 Spellcheck Bot - Josh Soref
23:47 Shellcheck - Robert Jackson
30:30 New tutorials & wrap up

Learn more: https://keptn.sh
Get started with tutorials: https://tutorials.keptn.sh
Join us in Slack: https://slack.keptn.sh
Star us on Github: https://github.com/keptn/keptn
Follow us on Twitter: https://twitter.com/keptnProject

A

Hi everyone and uh welcome to this week's uh community meeting uh it's march 18th um and we have quite a nice agenda because it's uh the first time that we are really focusing on community contributions. uh I think uh we don't have any captain uh maintainer contribution to present today, but it's really uh everything is from the community for the community so really excited to see what um what has been achieved by the community.

A

So I think you can see my screen um and, as always, I will just ask you to also put in your names in the attendee list. I will share the document just in a second with all the participants just be reminded. We are a cncf project. That means we're also following the code of conduct, um so please um be nice to each other be respectful, but it's as always in our community needs um just a quick um reminder also of of what happened already this week.

A

So for this meeting. Actually we don't have anything to clarify from the last minutes. I think we were all good uh on the presentation for last meeting. um Then we already had the captain user group, more kind of captain adoption uh focused meeting a more um captain, user-faced meeting. um We had the user group on.

A

uh I think it was on tuesday uh and we did a kind of a feature presentation of captain.8 if you have not seen it yet, if you're interested in how the on all the changes uh from the previous version to the latest version of captain uh or if you're, also a captain, developer and you're interested in how the new event thing is, is is done and uh how you can make use of multi-cluster uh support. Then uh we have a video here, make sure to watch the video.

A

um We did a kind of a deep dive on all the features. Also johannes was joining and uh explaining uh everything in clear detail so make sure to watch this.

A

If you're interested in the highlights, and also in the in the changes um yeah, I think we don't have anything anything else um to share here. I'm just asking the maintainers if they have everything if they have anything to share while I'm promoting our.

B

From my side um stay tuned next week, the ordered 8.1 releases coming out and published um yeah. I think this will. We will um present it next week uh at least the highlights that have been implemented um in this dev meeting.

A

uh So it will be already released next week or we just.

B

A

B

It will be released.

B

Maybe also important to to mention we plan to have now monthly releases, meaning that every fourth week a new version is available and released so that we can get faster feedback and also to to roll out new features, and they want to rather bug fix more quickly.

B

This means this will not be a heavy one. A heavy release, but with nice features in there with a couple of bug, fixes in there and yeah stay tuned to get to the latest update.

A

Cool cool. We are really looking forward to this one um yeah. With this I already see george hi and robert hi uh joining really great. To have you, um I think I'm handing over first to josh, uh as you will be, showing us uh on your uh the great spellcheck bot uh that is now uh also active in in captain.

A

I already added a couple of links, um but if you have something to, uh if you want to first present or then just show a little bit of your code, feel free stage is all yours, and can I share a screen? Yes here we.

C

Go your screen: okay,.

A

Let me double check.

C

But I have it. The problem is that it's showing me a whole bunch of windows which all have the same icon of google chrome unknown. So I now have to figure out which one it actually is, because zoom is not um being my friend. So give me a moment.

A

Sorry, yeah no worries no worries. I can also. If you want, we can pause the recording if you accidentally, sharing the wrong screen um and then you just let me know so, I'm just pausing here yeah here we go we're back yeah, I'm hanging over to you, george.

C

So, first I'm josh uh and uh as noted, we've added the check, spelling bot um and um what's a word, uh I don't actually know too much about captain. um I grew up in the united states and there was a movie long before my time called mary poppins, which actually there was a recent um kind of like sequel of sorts to mary poppins, so it might be in current um zeitgeist.

C

um But there was this word of supercalifragilisticexpialidocious um and a song to go with it.

C

It's a made up word and programmers make up words all the time, uh the problem and because they do we do uh you end up your average spell checker does a really bad job and people just end up ignoring them. So the spell checker here is able to understand some of the conventions that programmers have. If you change your case, um it will treat that as a new word.

C

So if you have super and then a capital cali and a capital fragilistic and a capital expia and a capital e and doshas, you will actually be able to recognize that super's a word and callie's a word well a or that will think about whether it's a word and in this case um super and cali are already in diction in the dictionary. So the only things you actually have to add are fragilistic expia and doshas. Lee is actually uh a sound from music. I believe- um and basically you would you generally for this.

C

You would add them to expect saying they're. We expect them to be in the corpus, but they're not really really words. Otherwise, if they were really words for our purpose, we would add them to the dictionary itself.

C

um The difference is basically if at some point you decide that you don't want to have supercalifragilisticexpialidocious in your dictionary in your code. You've just removed entirely. You don't want somebody to accidentally add it in as a typo or some other word, um and so the bot will recommend to remove things when it no longer sees them in the corpus.

C

um So you have checks. um There are two main actions that the bot currently responds to, that one is pushed is which is ideal for, if you're, making a change- and you want to test it before you make your pull request. If you have a fork, you just push your branch straight to github.

C

The action can run on that branch and report its issues before you make the pull request, so you don't actually have anybody else see that you've made a typo um and then um the action that we're currently using for uh captain is pull request target.

C

So it's configured to actually look at the merge between the master, I believe and your pull request, and it will, if it doesn't like it, will give you a cute little x um and I'd actually encourage captain um to block merges on these, so that you don't actually end up with um the errors appearing when somebody else makes a fork and tries to make a extra change past that because the bot is not currently paying any attention to whose fault that there's something that doesn't know about it just complains about it because it sees it.

C

So, basically, you would add an extra check in the configuration uh now there are two main ways to ignore files. One is excludes so um recently the test files were added as a pattern to exclude so that the bot will ignore them entirely, and it's also possible to be on that use only to say yeah.

C

The only director I care about is, for instance, a docs directory and they would first apply the exclusions and then it would say: oh the only things you care about are in docs and I will only check those if you do choose to make um the spell checker mandatory. You have to make sure it runs. Otherwise github will sort of wait forever. It's just a minor warning uh and again I highly recommend making the check required.

C

It's pretty easy to talk to the bot um it'll be even easier in the near future, and uh it's usually not so unreasonable.

C

So this is sort of what you will normally see from the bot. That says, I saw some things. I don't think they're right, but if they are, it gives you information about how to accept them. So, in this case, repository was missing. You know, I think this was supposed to be something, but it ended up not like that and updating has an extra e.

C

um When you are looking at uh a pull request, it will actually, uh if you're in the review version, it will actually try and show you where it found it. uh In this case, updating is around the sixth word in the line um and unfortunately, github only shows you the first 10 of these warnings. So if you have a whole bunch of new words, um you're going to actually want to look at the log instead and it will tell you the line numbers which columns they are, and it's pretty easy to respond to um now.

C

The if you click on the accept thing, it will give you a command that you can just sort of run and it will just as long as you have git and pearl. It will just clean up things for you. In this case, there were some stale words that had, I guess, been either removed or added to the dictionary um I'm in the either the next releases are always after you should actually be able to talk to the bot and it'll.

C

Just do it for you, but right now the easiest way is just copy and paste into a terminal and let it go. You can, of course, also manually remove the items. Basically, in this case there's an expect file, and these are individual lines in the expect file. You just remove them and similarly, if you add these three items into it, that's all it takes. um The expect file would like to be ordered alphabetically, but the bot doesn't really care um so yeah you copy and paste the suggestions, and it does things.

C

So if you're gonna use it for your own project, there is a repository which has um which is called spell checks this, which just has a pre-canned configuration to make it easy for people, including the ability to deal with the merge generally there's excludes, which I've mentioned, and only if you have a line which has maybe some test content or some binary content.

C

You can use a pattern to exclude it um ideally you're doing this either for something that's just a one-off or for a mask. Maybe your every time you call a certain function. It's always garbage data. That's just not words that you shouldn't be checking patterns will help you with that.

C

Unfortunately, I don't currently have a way to handle multi-line comments um or things like a multi-line comment, probably with the next couple of versions. I'll write a way to do that, it will probably be a different file, because the format for it is probably significantly different.

C

So the bot supports a base dictionary right now.

C

It has one main dictionary which is fairly expansive but is not particularly geared to code, I'm still in the process of collecting, uh basically, which words might end up being a more technically focused dictionary, and then you have the ability to create an allow file or really a directory of them, which is where you're, adding extra words to the dictionary and then reject lets you remove words from the dictionary, for instance, there's a word s-p-a-e, which is in the dictionary, because it's a word, but on average I've only seen it as a typo for space.

C

So if you would want to remove spay from the dictionary, you can just add it to reject and then, as far as the bot's concerned, it will be as if it wasn't in the dictionary at all. So if somebody types spae and sub sba, ce it'll complain about it um and then expect is again where it's looking for things that are not in the dictionary but which it found.

C

In our case the example xpi or doshis, um then there's the ability to add advice. uh So for one of the projects, that's using the bot, um it seems useful to tell people about binary files as a hint. So this content here at the bottom is from adding an advice file with some github markdown and basically every time it writes a comment. It will include that um things that are coming.

C

The next version should have probably at least twice as fast, because it will actually be checking two files concurrently um and it will actually start recognizing. One thing encounters a file which is roughly binary or gibberish. um So um these two things about udb in it and uh the build scripts in it file. The files ended up being just basically noise, there wasn't really real content, and so it's actually suggesting um it says.

C

Well, I skipped these files and you can add them to excludes to speed it up and have it not check them in the future. So that's maybe even by the end of the month and then the thing I'm really looking forward to is on this, where you'll just actually talk to the bot by quoting the line that suggests, and it will actually automatically make a commit cleaning up.

C

The expect file for you, so that's you selecting the line, quote reply, click comment and it makes the commit it obsoletes its comments and if you want, you can see the commit that it generated.

C

And some deployments I have a couple of different projects of microsoft that they're using it managed to actually convince the group at nasa to use it, which is really cool. And thank you captain for joining and questions.

A

C

A

uh Actually, um I kind of I experienced the.

C

A

Because we got a commit uh or a pull request actually from from a captain user.

C

A

He was adding this to uh he. The company he's working for uh to the captain adopters list, and the company name is not the real word, so the company name is kitopi uh and your bot immediately came up and uh telling us this is actually um yeah. It's might be. A made up, word might be a typo yeah.

C

Yeah uh uh so initially I didn't actually exclude the adopters file, and the argument I had to myself was that it is likely that if I'm a company first of all company names are things that get misfilled all the time.

C

um But if I'm adding myself to adopters, then that is actually a good way to say that word should be in the list of things so that when I actually mention myself elsewhere in the code, it should be expected to be spelled correctly, um but given that it was not added what in response to it, I've just made a pull request, suggesting to exclude the adopters file um either way works.

C

My preference in general is to actually check as many files as possible and add things to dictionaries that way you catch more mistakes. It also means that you're consistently using the same word both in your tests, your documentation and in your code, but it's up to the project how they want to do it. So my the current pull request I made on that was just exclude the doctor's file entirely.

A

Yeah uh and um as you've shown in the next release of um of your bot, it will be able to kind of do an automatic commit to include or execute words.

A

So in captain we are using uh or dco has to be enabled, or we are following this, so every commit has to be signed. So I'm wondering if you can automatically also sign the commits. Otherwise we would have to kind of to. uh It will be committed to a exclude file that lives inside.

C

Character right or is it.

A

C

Yeah, um okay, that's a good point! Thank you uh yeah! uh So right now it generates the commit and it blames the user in terms of the authorship, but it doesn't include a dco. I can certainly include a dco. It's not much work um uh so yeah. Thank you. This is why it's still in pre-release, I haven't ironed out enough of the edges, uh so yeah. I can probably do that. Maybe even tonight um the future's not ready yeah, absolutely.

C

The feature is unfortunately not ready, because the metadata that it's stashing is in a place which works fine for public repositories, but it doesn't work for private repositories and since my employer is one of the users um and our pri, our repositories are mostly private. I can't ship the feature until I get it working for that which is, um but as soon as I get it working for private repositories, I'll be able to make it generally available.

C

On the other hand, if captain wants to use it in pre-release, I'm happy to once we get the dco working, I'm happy to set captain up using it. There we're here.

A

C

Yeah, I think it would be a great feature to have.

A

Really cool, I'm just curious! Oh sorry! Behind it's going yeah.

B

I'm also curious: uh is there a team behind this um bot behind the spell checker or is it just you? It's just me.

C

I I use various channels to to chalk out features, uh but no it's just me. It's a it's a side project I've been doing spell checking of random stuff for like two decades. um It's a I do it for lots of reasons. One is it lets me figure out how healthy is a project? How easy is for me to contribute any small change?

C

Also, it's really frustrating both like trying to read documentation which has typos or trying to use a product where the user interfaces just has things that are misspelled and, of course, if something's misspelled searching for it, it's just a disaster, um and so yeah. It's I've iterated it over this in various languages in various ways, um and it seems like at a certain point. Oh github has this cool way to anchor it. Initially. Somebody asked about making it aci and I actually did a version for one project which was just a.

C

um I think it was a travis hook or it was for. I think it was travis, uh but at a certain point, github actions became a great way to do it. So now it's available this way and the I mean there are other features that I'm looking at there. In fact, the wiki has a whole list of features that I would like to do. um Some of the next things are like adding custom, not customizable, but like standard word lists for things like html or css or various languages, um but things like that.

C

Somebody else could make a pull request and I will work on integrating it once I figure out how I want it to work, um but thankfully, for the most part it just works. Almost always um I mean occasionally there'll be downtime um like a couple days ago, github had an outage so actions weren't working at all, but other than that. It's pretty much always gonna work and I'm available. You can just at me in github um and I'm on uh the captain slack uh at some point.

C

It might not scale, but I'm hoping it'll scale reasonably well.

A

Cool yeah thanks so much it's really. It's really a great project and I think it already saves us some some typos. So it's.

B

A

B

And as as we are discussing or talking right now about this feature, I also thought we should actually add it to our documentation, because there is where we have quite a lot of content and um also would make sense to to use the spell checker there and for.

A

B

A

It's a lot of written words, so it's not. It's actually marked down files.

C

As as you can see, it doesn't really care, it works just as well on markdown or code or comments or any format, so yeah, uh I'm happy to help set it up or you can give it a try on your own by just using the spell checklist repository or copying the config straight out of the caption repository.

C

It should be pretty easy and I'd actually really be quite happy if somebody else tried to do it without my hand, holding because I'd love to get the feedback of oh, I just did it and just worked or oh I've stumbled on this or that and needed a bit of help.

C

It's I find the best way to improve a product is letting somebody else use it and taking their feedback and saying so. What actually did you trip on? What did you need help with and actually improving those bits.

A

I'm adding this to the meeting dock as an action item also for the captain, docs and capture tutorials, and we can follow up then in the next video on this yeah. That's really cool.

A

Cool any more uh questions or feedback for tosh, because if not thanks so much um and uh we are oh, do you have more slides.

C

Just for reference there, basically there is a wiki. There is a spell check this, um which is the um template repository and then the marketplace, action uh and yeah. So that's it. um So thank you.

A

Thanks so much um in the because then we will be heading over from the spell check to the shell check it's uh actually when when I was going through the the notes for today I was like oh right. Why do do we? Have it twice? But it's we don't. Have it twice, it's two different things.

A

uh So robert. uh It's your turn. uh Thanks for your contribution and uh I'm I'm curious to learn more.

D

Okay, cool yeah. Let me just share real quick uh yeah, so this is a pr I put out there a couple weeks ago to incorporate a shell check action. um Yeah there was, there was some spelling mistakes. I fixed on this pr2, but uh yeah so like here um like here's how the action works. Basically, you know it's pretty simple: to define, it'll uh work on push or pull requests so like. If somebody pushes to you know their fork, they'll still get the deal here and basically it checks the syntax of them.

D

Let me actually show you a failure for it. Real quick, like I was doing some testing here.

D

So here I was testing a failure if uh yeah so, like I echoed uh an unquoted variable here. I don't even think the variable is defined too, but it was uh you know it kind of tells you like. You know something that you should. You know like look into fixing and if you you know, search google, for whatever the error code is like you'll find the official wiki by uh koala man. uh So yeah this isn't a project I maintained. This is somebody else's project uh but yeah.

D

I absolutely love his uh his tool and like or her little third tool. I love the third tool uh and they, you know, show you programmatic, load, correct code as well as like a whole rationale. You know like so I I think in this uh issue here like if you don't go to variable properly.

D

You know, there's like spaces in that variable so say like it's a file path and there's a space in there. It could prove problematic, depending on the shell version that you're using.

D

um Which is pretty cool uh yeah, I don't have a really cool slide or anything like that. It was just yeah. I I wanted to touch base on it really quickly and then also kind of you know like let everybody know how to ignore uh a rule if something like, if a rule needs to be ignored. I think there's a couple examples here. Sorry, I should have gotten an example right off the bat I.

B

Have a reminder for robert.

D

Thanks thanks, google, um so here you can ignore something for the entire file and I think this was the exit code so like what yeah one of the common things we do is uh like if dollar sign question mark is not equal to zero.

D

I think if we look this up, it's saying basically is you know the the correct code that they would recommend it would be like if you're doing like grab. uh You know some contents in some file. Do, if not grip, you know, or if not in this example make.

D

So then it's able to you know like have the remediation actions, but I don't want to change the code too much when I was learning the shell script, so I I didn't make those changes and instead I ignored it on the entire file or you can ignore on on a single line too, like if there's yeah, here's an example here I forgot what this was for.

D

uh Okay, yeah, I guess this was double quoting I I should have fixed that, but uh yeah. That's that's how you can ignore the next line instead of, like you, know, ignoring it for the entire file, because there might be certain situations where you might want to ignore. You know one specific syntax.

D

uh You know what the what the lender would consider is a tax issue that you might not consider a syntax issue.

C

If that makes sense,.

D

But yeah that's pretty much it. I uh yeah. We were able to lend all the shell scripts and now have it working on. I don't know why my github's looking so weird right now now I have it working on uh on there.

D

Does anybody have any questions about like this change or like how it might impact them.

A

I really think it helps us to to write better code um as it's uh all these uh the spell check uh the.

C

Shell check error codes. You showed.

A

They have also this rationale behind kind of helping us to take a look if we really want to follow their recommendations or if we want to follow others, but it's yeah really cool. Actually, I didn't know that it exists uh cool that you added it to our project, um so I I think, but I haven't been coding uh on the shelf scripts for a couple of uh for for quite a while now, so, uh if maybe somebody's on the call, who has more experience with this or maybe even got already recommendations from the shell check.

A

Please please comment on this.

D

Yeah I'm a huge fan of lenten uh personally, because you know not not every situation, you can write unit tests and you know I I think shell scripts are one of those things that's hard to write unit tests for or, like you know, quality checks for docker files. um You know in the future, I'd like to also contribute another lending tool. um I was thinking either like how to lint or go to lint or a couple tools for like lending docker files to you know, make recommendations on uh quality.

A

Yeah, I think it's a great uh it's it's a great thing, um everything that helps with um keeping up the quality high and then doing this linking, as you said, um unit testing for shell scripts might not be that easy.

A

So that's that's really cool! I'm sorry! Here we go um yeah. So thanks for uh for for sharing these two contributions, um thanks for adding also everything to the document just making this link um are there any uh other, uh let's say, agenda items uh that are not in the agenda yet that we want to cover in the today's.

C

B

Not from my side, I just can recommend watching the the feature high under the the video that you mentioned at the beginning, as it shows really the new features of kept node.8 and how you can use them. This is what I would recommend, but other than that I don't have any item for today.

A

Okay, cool, um then thanks everyone. Oh uh one thing I I want to highlight because it was just released um a couple of minutes before our meeting. uh We will update this.

A

uh We will update the landing page to go to uh captain 0.8 um quite soon, but we were just waiting for more tutorials to be finished and to be ready, and just a couple of minutes ago or hours ago, um we got a new community contribution, it's a captain in the box and it's a really neat way to start with captain um without a full-grown kubernetes cluster in the public cloud, but actually running this uh with. um I think it's micro, kubernetes, uh yeah micro kubernetes uh uh on the on the vm.

A

So um the idea is, uh or the tutorials from sierra and the idea is just to to launch a ec2 instance ubuntu-based pc2 instance, and then you can run this and it will basically create everything that you would create in the full tutorial with capta. I will create everything for you and then you can just kind of uh learn from from this, uh and you can click through. You can then do all the use cases, but you don't have to set it up by yourself.

A

Everything is automated for you, the whole installation I think, takes about um five to ten minutes, but then you get all the services on board. You have captain installed. You have the first evolution of the quality gates already with your sli's, your slos everything's there for you. So if you ever need a working captain environment.

C

uh You can get started with this.

A

uh It will set up the whole thing within 10 minutes and you're good to go. I just want to highlight this. um He will also join us in one of the next meetings or we'll do a um a video together, so in any way we'll try to also make this more popular, but I just wanted to share it with you first.

A

So it's something in the chat. So let me just double check just added.

B

The links that robert posted to the document so that we don't lose them.

A

uh Yes, thank you perfect.

A

um And there was one comment about the the airplane robert: what.

D

Oh yeah, I was just saying uh yeah. The the captain in the box uh concept is pretty cool uh it. It would be nice uh to you know like whenever the pandemic is over, uh you know and people start traveling again. If, uh if maybe there was like a mini cube, uh you know like setup.

D

We could do instead of, like you know, like an ec2 setup, uh so that you know there would be like a kept in a box with mini cube or something.

A

Yes, so I think you could also run it with micro kubernetes on your local machine that should work. uh We also have a captain uh on k3s captain on keys, but it's a little bit smaller installation and we usually use it only for the quality gate or the auto remediation use case and not for captain full installation, um but we will come up with more options to basically uh make it also developer friendly. Just have it on your local.

C

Machine and then navigate with this airplay mode.

A

But uh yeah so that it's it's easier to just create it on your machine and then get going.

A

Okay, uh then thanks everyone for joining. um I don't see any more questions in the chat here, also not added to the document so.

B

A

Thanks everyone thanks josh and robert for presenting, really appreciate your contributions and uh yeah our next captain community meeting and development meetings. Then next week, and I'm already looking forward to captain 0.8.1 and uh yeah have a great evening or a great rest.

B

A

Enjoy and see you all next week, bye.

B