Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Create VSCode Dev Container #3821

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

SudoBrendan
Copy link
Collaborator

@SudoBrendan SudoBrendan commented Sep 5, 2024

  • Add a new stage to ci-rp to include all local build tools
  • Add config for vscode Dev Containers extension

Which issue this PR addresses:

Improvements for local dev. Makes it so docs/prepare-your-dev-environment.md is basically unused.

What this PR does / why we need it:

Implements VSCode Dev Containers so that local dev environments are in sync with what CI runs (golang versions, other tools and versions, etc)

Test plan for issue:

  1. If you don't have it already, install VSCode
  2. Set up the Dev Containers Extension
code --install-extension ms-vscode-remote.remote-containers
  1. [optional] If you have some "standard" VSCode Extensions you also want in your Dev Containers, you can set those up in File > Preferences > Settings > Extensions > Dev Containers (e.g. I'm a VIM normie, so I added vscodevim.vim / etc)
  2. In the bottom left corner of the IDE, a symbol like >< now appears, click it, which opens a dropdown menu - and select Reopen in Dev Container
  3. The ci-rp base dev image is built, and then you are launched into the standard dev environment with all required tools installed. You can do things like make generate etc without additional local setup (and all it took was podman and podman-docker!)

Is there any documentation that needs to be updated for this PR?

Yea - will follow up with this before merge (still WIP).

How do you know this will function as expected in production?

N/A - local only

- Add a new stage to ci-rp to include all local build tools
- Add config for vscode Dev Containers extension
@jaitaiwan
Copy link
Contributor

LGTM so far

Copy link

Please rebase pull request.

@github-actions github-actions bot added the needs-rebase branch needs a rebase label Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-rebase branch needs a rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants