Building, Testing, and Contributing¶
Testing Latest Commits on HEAD¶
There are several ways to use DDEV’s latest-committed HEAD version:
- Download the latest master branch artifacts from nightly.link. Each of these is built by the CI system, signed, and notarized. Get the one you need and place it in your
- Homebrew install HEAD: On macOS and Linux, run
brew unlink ddev && brew install ddev/ddev/ddev --HEAD --fetch-HEADto get the latest DDEV commit, even if it’s unreleased. Since you’re building this on your own computer, it’s not signed or notarized, and you’ll get a notification that instrumentation doesn’t work, which is fine. If you’re using Linux/WSL2, you’ll likely need to install build-essential by running the following command:
sudo apt install -y build-essential.
- Build manually: If you have normal build tools like
goinstalled, you can check out the code and run
- Gitpod You can use the latest build by visiting DDEV on Gitpod.
Testing a PR¶
Each PR build creates GitHub artifacts you can use for testing, so you can download the one you need from the PR page, install it locally, and test using that build.
Download and unzip the appropriate binary and place it in your
If you’re using Homebrew, start by unlinking your current binary:
Next, unzip the binary you downloaded, make it executable, and move it to your bin folder:
Verify the replacement worked by running
ddev -v. The output should be something like
ddev version v1.19.1-42-g5334d3c1, instead of the regular
ddev version v1.19.1.
macOS and Unsigned Binaries
macOS doesn’t like these downloaded binaries, so you’ll need to bypass the automatic quarantine to use them:
(The binaries on the master branch and the final release binaries are signed.)
You do not typically have to install anything else other than the downloaded binary; when you run it it will access any Docker images that it needs.
After you’re done, you can delete your downloaded binary and re-link the original Homebrew one:
Open in Gitpod¶
Gitpod provides a quick, preconfigured DDEV experience in the browser for testing a PR easily without the need to set up an environment. In any PR you can use the URL
https://gitpod.io/#https://github.com/ddev/ddev/pulls/<YOUR-PR> to open that PR and build it in Gitpod.
To open and work on DDEV you can use the button below.
If you want to run a web project, you can check it out into
/workspace/<yourproject> and use it as usual. The things you’re familiar with work normally, except that
ddev-router does not run.
A Gitpod dummy project for is provided by default in
/workspace/d9simple. If you’re testing your own project, you will need to delete it to free up reserved host ports by running
ddev delete -Oy d9simple. Then you can run
ddev start to work with your own.
Making Changes to DDEV Images¶
If you need to make a change to one of the DDEV images, it will need to be built with a specific tag that’s updated in
For example, make a change to
containers/ddev-webserver/Dockerfile, then build it:
pkg/versionconstants/versionconstants.go to set
var WebTag = "20210424_fix_dockerfile" and
ddev version should show you that you are using the correct webtag, and
ddev start will show it.
It’s easiest to do this using Gitpod (see above) because Gitpod already has
docker buildx all set up for you and the built DDEV binary is in the
Pull Requests and PR Preparation¶
When preparing your pull request, please use a branch name like
20230901_rfay_short_description) so it’s easy to identify you as the author.
Docker Image Changes¶
If you make changes to a Docker image (like
ddev-webserver), it won’t have any effect unless you:
- Push an image with a specific tag by navigating to the image directory (like
containers/ddev-webserver), and running
make push DOCKER_REPO=youruser/yourimage VERSION=<branchname>.
- Multi-arch images require you to have a Buildx builder, so
docker buildx create --name ddev-builder-multi --use.
- You can’t push until you
- Push a container to hub.docker.com. Push with the tag that matches your branch. Push to
make push DOCKER_ORG=<yourorg> VERSION=<branchname>in the container directory. You might have to use other techniques to push to another repository.
WebTagthat relate to the Docker image you pushed.
Local Builds and Pushes¶
buildx successfully you have to have the
buildx Docker plugin, which is in many environments by default.
To build multi-platform images you must
docker buildx create --use as a one-time initialization.
If you want to work locally with a quick build for your architecture, you can:
make mariadb_10.3 VERSION=<version>etc.
To push manually:
If you’re pushing to a repository other than the one wired into the Makefile (like
Pushes Using GitHub Actions¶
To manually push using GitHub Actions,
For Most Images¶
- Visit Actions → Push tagged image
- Click “Run workflow” in the blue band near the top.
- Choose the branch, usually
masterand then the image to be pushed,
ddev-dbserver, etc. Also you can use
allto build and push all of them. Include a tag for the pushed image and GitHub will do all the work.
- Visit Actions → Push tagged db image
- Click “Run workflow” in the blue band near the top.
- Choose the branch, usually
master. Include a tag for the pushed image and GitHub will do all the work.
- You’ll want both your fork/branch and the upstream as remotes in Git, so that tags can be determined. For example, the upstream Git remote can be
https://github.com/ddev/ddevand your fork’s remote can be
firstname.lastname@example.org:<yourgithubuser>/ddev. Without the upstream, Git may not know about tags that it needs for tests to work.
- To run tests, you’ll want
~/tmpto be allowed in Docker. This is not normally an issue as the home directory is available by default in most Docker providers.
Build the project with
make and your resulting executable will end up in
.gotmp/bin/linux_arm64/ddev (for Linux) or
.gotmp/bin/windows_amd64/ddev.exe (for Windows) or
.gotmp/bin/darwin_arm64/ddev (for macOS).
Build/test/check static analysis with:
make # Builds on current os/architecture make linux_amd64 make linux_arm64 make darwin_amd64 make darwin_arm64 make windows_amd64 make test make clean make staticrequired
Normal test invocation is
make test. Run a single test with an invocation like
go test -v -run TestDevAddSites ./pkg/... or
make testpkg TESTARGS="-run TestDevAddSites". The easiest way to run tests is from inside the excellent golang IDE GoLand. Click the arrowhead to the left of the test name.
To see which DDEV commands the tests are executing, set the environment variable
GOTEST_SHORT=true to run one CMS in each test, or
GOTEST_SHORT=<integer> to run exactly one project type from the list of project types in the TestSites array. For example,
GOTEST_SHORT=5 make testpkg TESTARGS="-run TestDdevFullSiteSetup" will run only
TestDdevFullSiteSetup against TYPO3.
To run a test (in the
cmd package) against a individually-compiled DDEV binary, set the
DDEV_BINARY_FULLPATH environment variable, for example
DDEV_BINARY_FULLPATH=$PWD/.gotmp/bin/linux_amd64/ddev make testcmd.
The easiest way to run tests is using GoLand (or VS Code) with their built-in test runners and debuggers. You can step through a specific test; you can stop at the point before the failure and experiment with the site that the test has set up.
Anybody can view the CircleCI automated tests, and they usually show up any problems that are not OS-specific. Click through on the testing section of the PR to see them.
The Buildkite automated tests require special access, which we typically grant to any PR contributor that asks for it.
Docker Image Development¶
The Docker images that DDEV uses are included in the
containers/ddev-php-basethe base build for
containers/ddev-webserverprovides the web servers for per-project
dbcontainer for per-project databases.
containers/ddev-routerprovides the central router image.
containers/ddev-ssh-agentprovides a single in-Docker-network SSH agent so projects can use your SSH keys.
When changes are made to an image, they have to be temporarily pushed to a tag—ideally with the same as the branch name of the PR—and the tag updated in
pkg/versionconstants/versionconstants.go. Please ask if you need a container pushed to support a pull request.
Pull Request Pro Tips¶
- Fork the repository and clone it locally. Connect your local to the original ‘upstream’ repository by adding it as a remote, and pull upstream changes often so you stay up to date and reduce the likelihood of conflicts when you submit your pull request. See more detailed instructions here.
- Create a branch for your edits.
- Be clear about the problem and how someone can recreate it, or why your feature will help. Be equally clear about the steps you took to make your changes.
- It’s best to test. Run your changes against any existing tests and create new tests when needed. Whether tests exist or not, make sure your changes don’t break the existing project.
Open Pull Requests¶
Once you’ve opened a pull request, a discussion will start around your proposed changes. Other contributors and users may chime in, but ultimately the decision is made by the maintainer(s). You may be asked to make some changes to your pull request. If so, add more commits to your branch and push them. They’ll automatically go into the existing pull request.
If your pull request is merged, great! If not, no sweat; it may not be what the project maintainer had in mind, or they were already working on it. This happens, so our recommendation is to take any feedback you’ve received and go forth and pull request again. Or create your own open source project.
Unless explicitly stated, we follow all coding guidelines from the Go community. While some of these standards may seem arbitrary, they somehow seem to result in a solid, consistent codebase.
It is possible that the codebase does not currently comply with these guidelines. We are not looking for a massive PR that fixes this since that goes against the spirit of the guidelines. All new contributions should make a best effort to clean up and make the codebase better than they left it. Obviously, apply your best judgment. Remember, the goal here is to make the codebase easier for humans to navigate and understand. Always keep that in mind when nudging others to comply.
make staticrequired to ensure that your code can pass the required static analysis tests.
- All code should be formatted with
- All code should pass the default levels of
- All code should follow the guidelines covered in Effective Go and Go Code Review Comments.
- Comment the code. Tell us the why, the history and the context.
- Document all declarations and methods, even private ones. Declare expectations, caveats and anything else that may be important. If a type gets exported, having the comments already there will ensure it’s ready.
- Variable name length should be proportional to its context and no longer.
noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo. In practice, short methods will have short variable names and globals will have longer names.
- No underscores in package names. If you need a compound name, step back, and re-examine why you need a compound name. If you still think you need a compound name, lose the underscore.
- All tests should run with
go testand outside tooling should not be required. No, we don’t need another unit testing framework. Assertion packages are acceptable if they provide real incremental value.
- Even though we call these “rules” above, they are guidelines. Since you’ve read all the rules, you now know that.
If you are having trouble getting into the mood of idiomatic Go, we recommend reading through Effective Go. The Go Blog is also a great resource. Drinking the kool-aid is a lot easier than going thirsty.