Adding devcontainer for development ease - #7111
Open
RohanRusta21 wants to merge 1 commit into
Open
Conversation
RohanRusta21
requested review from
Warashi,
ffjlabo,
khanhtc1202 and
mohammedfirdouss
August 3, 2026 10:01
Contributor
|
👋 Hi @RohanRusta21, welcome to PipeCD and thanks for opening your first pull request! We’re really happy to have you here Before your PR gets merged, please check a few important things below. Helpful resources
DCO Sign-offAll commits must include a In case you forget to sign-off your commit(s), follow these steps: For the last commit: git commit --amend --signoff
git push --force-with-leaseFor multiple commits: git rebase --signoff origin/master
git push --force-with-leaseRun checks locallyBefore pushing updates, please run: make checkThis runs the same checks as CI and helps catch issues early. 💬 Need help?If anything is unclear, feel free to ask in this PR or join us on the CNCF Slack in the #pipecd channel. Thanks for contributing to PipeCD! ❤️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does:
Adds a Dev Container so contributors can get a working environment without
installing the toolchain by hand.
.devcontainer/devcontainer.json— one file, based onmcr.microsoft.com/devcontainers/go:1.26-trixie, which ships the Go toolchain,the Go tools (gopls, dlv) and make/gcc that
go test -raceneeds.onCreateCommandinstalls kind v0.32.0, kubectl and Helm 3.17.3, and pre-fetchesdependencies (
go mod download,make setup-envtest,make update/web-deps) inparallel, so
make build,make testandmake checkwork on first open.CONTRIBUTING.md: replaces the "Online one-click setup for contributing"placeholder with usage instructions for Codespaces and VS Code.
Versions are pinned to CI (
build.yaml,lint.yaml) andweb/package.json, withcomments naming the source file so they get bumped together.
Notes:
make lint/goandmake gen/codebind-mount${PWD}, which only resolves for a daemon runninginside the container.
"moby": falseis required: Moby packages are not published for Debian trixie, sothe feature installs Docker CE instead.
satisfies go.mod's minimum, but it is not an exact pin.
docs/README.md.make gen/codeandmake run/pipecdneeddocker run --privileged --rm tonistiigi/binfmt --install amd64first, since bothare amd64-only in this repo today. Everything else runs natively.
Why we need it:
Setting up a local environment today means installing eight tools whose versions are
spread across five files (
go.mod,web/package.json,.github/workflows/build.yaml,.github/workflows/lint.yaml,docs/README.md), and several requirements are notdocumented anywhere:
make test/gopasses-race, so it needs a C compiler; the failure does not say so.make test/goalso needsKUBEBUILDER_ASSETS, i.e.make setup-envtestmust run first.make lint/goandmake gen/codeneed Docker, and break on setups where${PWD}is not visible to the daemon.
web/yarn.lock.It also helps Windows contributors, who currently need WSL —
docs/README.mdnotesthat
makeandgrepare not available in PowerShell. And runningmake up/local-clusterinside Docker-in-Docker keeps the kind cluster, thekind-registrycontainer and thepipecd-datavolume off the contributor's own Dockerand kubeconfig.
Finally,
CONTRIBUTING.mdhas been advertising this as pending — "We are preparingGitpod and Codespace to facilitate the setup process for contributing." This implements
the Codespaces and VS Code half of that.
Which issue(s) this PR fixes:
Fixes #6581
Does this PR introduce a user-facing change?: No
contributor environment; no PipeCD component, API, configuration or chart is touched.