README.md
1## About
2
3This directory contains a collection of scripts used to build and manage this
4repository. If there are any issues regarding the intention of a particular
5script (or even part of a certain script), please reach out to us.
6It may help us either refine our current scripts, or add on new ones
7that are appropriate for a given use case.
8
9## DinD (dind.sh)
10
11DinD is a wrapper script which allows Docker to be run inside a Docker
12container. DinD requires the container to
13be run with privileged mode enabled.
14
15## Generate Authors (generate-authors.sh)
16
17Generates AUTHORS; a file with all the names and corresponding emails of
18individual contributors. AUTHORS can be found in the home directory of
19this repository.
20
21## Make
22
23There are two make files, each with different extensions. Neither are supposed
24to be called directly; only invoke `make`. Both scripts run inside a Docker
25container.
26
27### make.ps1
28
29- The Windows native build script that uses PowerShell semantics; it is limited
30unlike `hack\make.sh` since it does not provide support for the full set of
31operations provided by the Linux counterpart, `make.sh`. However, `make.ps1`
32does provide support for local Windows development and Windows to Windows CI.
33More information is found within `make.ps1` by the author, @jhowardmsft
34
35### make.sh
36
37- Referenced via `make test` when running tests on a local machine,
38or directly referenced when running tests inside a Docker development container.
39- When running on a local machine, `make test` to run all tests found in
40`test`, `test-unit`, `test-integration`, and `test-docker-py` on
41your local machine. The default timeout is set in `make.sh` to 60 minutes
42(`${TIMEOUT:=60m}`), since it currently takes up to an hour to run
43all of the tests.
44- When running inside a Docker development container, `hack/make.sh` does
45not have a single target that runs all the tests. You need to provide a
46single command line with multiple targets that performs the same thing.
47An example referenced from [Run targets inside a development container](https://docs.docker.com/opensource/project/test-and-docs/#run-targets-inside-a-development-container): `root@5f8630b873fe:/go/src/github.com/moby/moby# hack/make.sh dynbinary binary cross test-unit test-integration test-docker-py`
48- For more information related to testing outside the scope of this README,
49refer to
50[Run tests and test documentation](https://docs.docker.com/opensource/project/test-and-docs/)
51
52## Vendor (vendor.sh)
53
54A shell script that is a wrapper around Vndr. For information on how to use
55this, please refer to [vndr's README](https://github.com/LK4D4/vndr/blob/master/README.md)
56