Skip to content

Codespaces

Use GitHub codespaces as a pre-built and pre-configured development environment. This is especially useful for Windows users who may not have make installed. It is also useful for Linux and MacOS users who may not wish to download tools just to contribute to docs.

Review this video to see how this works.

Keptn + GitHub codespaces video

As shown in the video, the steps to set up a new Codespace are:

  1. Create a fork of the repository. Keptn software and documentation are in the link repository.
  2. In your fork, click the green Code button
  3. Switch to Codespaces tab and create a new codespace

You will be presented with a fully configured environment with access to all the tools you require to develop software or documentation for Keptn.

The interface is similar to that of Visual Studio Code.

To develop or modify software or documentation, the steps are:

  1. Make your modifications and test those modifications
  2. Go back to Codespaces and click on the "Source Control" button on the left
  3. Find the file(s) that you modified and click the "+" button to create a commit
  4. Supply a commit message, adhering to the conventions for Keptn commits
  5. Sign the commit by clicking the "..." button and selecting "Commit -> Commit Staged"
  6. Click the "..." button again and select "Push" to push your changes to your fork
  7. Go to the UI for your fork and create a PR in the normal way.
  8. After your PR has been merged, go to your GitHub page, select "Codespaces", and delete this codespace.

Comments