65cfcc28ab
Provide more context to the steps we're doing. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> |
||
|---|---|---|
| .. | ||
| dockerfile | ||
| dockerfiles | ||
| make | ||
| test | ||
| validate | ||
| buildkit-ref | ||
| dind | ||
| dind-systemd | ||
| generate-authors.sh | ||
| generate-swagger-api.sh | ||
| generate-test-certs.sh | ||
| generate-test-rogue-certs.sh | ||
| make.ps1 | ||
| make.sh | ||
| README.md | ||
| vendor.sh | ||
| with-go-mod.sh | ||
About
This directory contains a collection of scripts used to build and manage this repository. If there are any issues regarding the intention of a particular script (or even part of a certain script), please reach out to us. It may help us either refine our current scripts, or add on new ones that are appropriate for a given use case.
DinD (dind.sh)
DinD is a wrapper script which allows Docker to be run inside a Docker container. DinD requires the container to be run with privileged mode enabled.
Generate Authors (generate-authors.sh)
Generates AUTHORS; a file with all the names and corresponding emails of individual contributors. AUTHORS can be found in the home directory of this repository.
Make
There are two make files, each with different extensions. Neither are supposed
to be called directly; only invoke make. Both scripts run inside a Docker
container.
make.ps1
- The Windows native build script that uses PowerShell semantics; it is limited
unlike
hack\make.shsince it does not provide support for the full set of operations provided by the Linux counterpart,make.sh. However,make.ps1does provide support for local Windows development and Windows to Windows CI. More information is found withinmake.ps1by the author, @jhowardmsft
make.sh
- Referenced via
make testwhen running tests on a local machine, or directly referenced when running tests inside a Docker development container. - When running on a local machine,
make testto run all tests found intest,test-unit,test-integration, andtest-docker-pyon your local machine. The default timeout is set inmake.shto 60 minutes (${TIMEOUT:=60m}), since it currently takes up to an hour to run all of the tests. - When running inside a Docker development container,
hack/make.shdoes not have a single target that runs all the tests. You need to provide a single command line with multiple targets that performs the same thing. An example referenced from Run targets inside a development container:root@5f8630b873fe:/go/src/github.com/moby/moby# hack/make.sh dynbinary binary test-unit test-integration test-docker-py - For more information related to testing outside the scope of this README, refer to Run tests and test documentation
Vendor (vendor.sh)
A shell script that is a wrapper around go mod vendor.