Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 3.56 KB

Codespaces.md

File metadata and controls

51 lines (31 loc) · 3.56 KB
Raw

Using Codespaces

Codespaces allows you to develop in a Docker container running in the cloud. You can use an in-browser version of VS Code or the full VS Code application with the GitHub Codespaces VS Code Extension. This means you don't need to install any prerequisites on your current machine in order to develop in dotnet/runtime.

Create a Codespace

The dotnet/runtime repo runs a nightly GitHub Action to build the latest code in it. This allows you to immediately start developing and testing after creating a Codespace without having to build the whole repo. When the machine is created, it will have built the repo using the code as of 6 AM UTC of that morning.

  1. From this repository's root, drop-down the Code button and select the Codespaces tab.

New codespace button

  1. Click the drop-down at the side of the Create codespace on main button and select Configure and create codespace

Configure and create codespace

  1. Select which Dev container configuration you want to use.

Dev container configuration

  • For libraries work, pick .devcontainer/libraries/devcontainer.json.
  • For WASM work, pick .devcontainer/wasm/devcontainer.json.
  1. Select the Machine type. For dotnet/runtime, it is recommended to select at least a 4-core machine. You can also verify that a Prebuild is ready.

Codespace machine size

If these instructions are out of date, see https://docs.github.com/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace for instructions on how to create a new Codespace.

Updating dotnet/runtime's Codespaces Configuration

The Codespaces configuration is spread across the following places:

  1. The .devcontainer folder contains subfolders for each development scenario:
    • Libraries: Used by developers working in src/libraries.
    • Wasm: Used by developers working on the browser-wasm workload.
    • Scripts: Contains any scripts that are executed during the creation of the codespace. This has the build command that builds the entire repo for prebuilds.
  2. Each development scenario folder contains the following files:
    • The devcontainer.json file that configures the codespace and has VS Code / Environment settings.
    • The Dockerfile used to create the Docker image
  3. The GitHub Action can be configured by following the instructions at https://docs.github.com/codespaces/prebuilding-your-codespaces/configuring-prebuilds.

To test out changes to the .devcontainer files, you can follow the process in the Applying Changes to your Configuration docs. This allows you to rebuild the Codespace privately before creating a PR.

Testing out your Changes

To test out your changes you can run the Codespaces Prebuilds Action in your fork against a branch with your changes.