github.com/jiasir/docker@v1.3.3-0.20170609024000-252e610103e7/hack/README.md (about)

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