Skip to content

Draft: add vscode devcontainer setup

David Pisek requested to merge dpisek-add-vscode-devcontainer into main

What does this MR do?

Adds setup to support vscode remote containers.

This will allow a low-friction entry point for contributors who are using docker and vscode, as it provides a means to spin up a controlled environment and even provide baseline vscode-extensions that are useful when working on gitlab-ui.

Instructions:

  1. Open the project with vscode - important: needs to be a fresh open
  2. Install the extension that gets suggested by vscode
  3. When vscode prompts that it found a dev container configuration click "Repopen in Container"
  4. Wait until first build and install has completed (note: this can take a while - it might also help to increase the memory docker has been allocated)
  5. Open a new terminal within vscode - you should now be within the freshly built dev environment and be able to run yarn start, which will get storybook up and running

Detailed information, further instructions and a nicely animated gif that demonstrates the process above can be found here: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by David Pisek

Merge request reports