keptn Keptn Tutorials, 1 Jun 2023

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: How GitHub Codespace Makes Contributing to Keptn & Kept Docs Much Easier!

Description

How GitHub Codespace Makes Contributing to Keptn & Kept Docs Much Easier!

In this video Adam Gardner, DevRel at Dynatrace, walks you through, step-by-step, how to make a change to a Keptn repo using GitHub Codespaces by showing:
- How to fork a repo
- Code: Create Codespace on main
- Using the VS Code / Codespaces UI how to make a change
- How to stage the changes, commit staged as signed off (as required by CNCF & Keptn projects), and push those changes
- How to create a PR

A

Hey everyone in this video I want to show you how GitHub code spaces can make contributing to Captain and Captain docs much easier. So, let's imagine we want to make a change to the captain. Docs well I'm, going to use the lifecycle toolkit repository as an example.

A

The first thing you're going to want to do is go up to the fork button and it'll say you don't have any Forks of this repository so go ahead and create a fork under your account, go ahead and go to the code button and flick across from local to code spaces and then click the green, create code space on Main. So after a minute or so, you're dropped into this user interface, which, if you've ever used Visual Studio code, will look very familiar.

A

Basically, what you have is a running virtual machine and the copy of the captain code, so you can make any changes and it's all kind of Linked In nicely to GitHub. Okay, so I'm gonna go to the captain life cycle, documentation and, let's imagine I I- want to make a change. So let's go into the docs and I, don't know getting started page as an example.

A

Let's imagine, I have found a typo or want to add a new bullet point, so I'm just going to copy some of this text so that I can find it in my code, space click back to the code space and go to the search icon and just paste your text in there, and you should get a result clicking that opens the markdown file that we need to change so I'm going to go ahead and make the change now, if I change directory into the docs directory, which are where all the documentation for the website is so I do a CD into Docs, so I can type make markdown lint, and this will go ahead and check that the syntax of my markdown is actually correct.

A

Notice, I've actually got an error here and it's telling me how I should fix it. It's saying Max one sentence should be online, so just putting that on a new line and then running make markdownlin again should make the linter happy yep. It's happy! No errors. This time.

A

Now, let's preview, my changes, so I can type make server and this will go ahead and spin up a copy of the documentation website in the code space notice down on the bottom right hand, corner here: you've got a box that says your application is running on Port 1314 open in a browser. If you click that link, it will actually try and open the documentation page, but you'll get a 502..

A

That's okay! That's just code spaces being a bit too eager to show you the the link so wait until the code space shows you. This web server is available at localhost1314 press Ctrl C to stop. If you now refresh that page with the 502, your preview of the captain, documentation website will be up and running so go ahead and navigate to the page that you changed and you should see your changes reflected on the preview documentation website.

A

Now any changes you make will be reflected live so if I chain, if I, remove that blah blah blah. For example, you'll see that code spaces has detected the change and is rebuilding the site. So again, if I refresh the page.

A

Now, let's imagine you are happy with your changes and you're ready to raise the pr ick back to code spaces and go to the source control button, which is the third one down on the left, find the file or files that you have changed in this case, I've only changed one markdown file, which is this index MD click the little plus button to Stage.

A

The changes give your commit a commit message: I highly recommend that you make it a conventional commit message as in docs colon some message and make sure that the s after the colon that I.E the first word is NOT. Capitalized I have have hit this issue as well, so make it all lower case now, don't click commit yet Captain and the cncf require that all commits be signed.

A

So, instead of commit go to the three little dots and click the drop down go to commit and then commit staged signed off this second bottom option here, so your changes have now been committed, go back to the three dots and go to push, and this will push the changes up to your fork of the repository. So in a new tab, navigate to your GitHub account and you should see the fork that you created go into there and the very first commit that you see should be whatever you've just done.

A

Docs some message- and it says the branch is one commit ahead of Captain Main, and that is it. You are now ready to go to the captain version of the lifecycle toolkit and create a PR. That's how easy it is with GitHub code spaces to actually raise a documentation, PR or indeed a core PR or captain.

A

Now there's one extra thing: GitHub code spaces gives you a generous free tier each month, but I always like to go to my GitHub account and go up to code spaces in the top menu here, find the code space that is currently running, click, the three little dots and hit delete, and that will completely delete that code, space environment, so you're not going to get charged for that environment, anymore. I, hope this helps get started, committing and improving the captain, documentation and also the core Captain code. Thanks.