moby/hack
Sebastiaan van Stijn 7839ff2244
Bump API version
With the Moby/Docker split, no decisions have been
made yet how, and when to bump the API version.

Although these decisions should not be lead
by Docker releases, I'm bumping the API version
to not complicate things for now; after this bump
we should make a plan how to handle this in future
(for example, using SemVer for the REST api, and
bump with every change).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-06-09 14:58:01 +02:00
..
dockerfile Revert ONCLR and OPOST changes 2017-06-07 13:14:52 -07:00
integration-cli-on-swarm Update ContainerWait API 2017-05-16 15:11:39 -07:00
Jenkins Update docker daemon to dockerd 2016-12-27 17:32:15 +08:00
make Bump API version 2017-06-09 14:58:01 +02:00
validate Remove compose-bindata script, it should move to docker/cli 2017-05-09 10:38:36 -04:00
dind Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" 2017-02-13 11:01:54 -08:00
generate-authors.sh Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" 2017-02-13 11:01:54 -08:00
generate-swagger-api.sh Convert ContainerTopOKResponse from swagger spec. 2017-01-03 11:47:47 -05:00
install.sh make it clearer which packages to install for AUFS support 2017-05-09 15:02:33 -04:00
make.ps1 Merge pull request #33235 from Microsoft/jjh/tweakmakeps1 2017-05-17 16:24:23 +02:00
make.sh Update golang to 1.8 2017-05-10 20:06:27 -04:00
README.md Adding a README.md for the hack folder. 2017-05-15 17:06:35 +02:00
release.sh Update SKIP_RELEASE_BUILD to only check for the string "1" (so it has to be exactly "SKIP_RELEASE_BUILD=1" to skip the release build) 2017-04-06 11:56:26 -07:00
vendor.sh Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" 2017-02-13 11:01:54 -08:00

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.

Install (install.sh)

Executable install script for installing Docker. If updates to this are desired, please use hack/release.sh during a normal release. The following one-liner may be used for script hotfixes:

  • aws s3 cp --acl public-read hack/install.sh s3://get.docker.com/index

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.sh since it does not provide support for the full set of operations provided by the Linux counterpart, make.sh. However, make.ps1 does provide support for local Windows development and Windows to Windows CI. More information is found within make.ps1 by the author, @jhowardmsft

make.sh

  • Referenced via make test when running tests on a local machine, or directly referenced when running tests inside a Docker development container.
  • When running on a local machine, make test to run all tests found in test, test-unit, test-integration-cli, and test-docker-py on your local machine. The default timeout is set in make.sh to 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.sh does 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 cross test-unit test-integration-cli test-docker-py
  • For more information related to testing outside the scope of this README, refer to Run tests and test documentation

Release (release.sh)

Releases any bundles built by make on a public AWS S3 bucket. For information regarding configuration, please view release.sh.

Vendor (vendor.sh)

A shell script that is a wrapper around Vndr. For information on how to use this, please refer to vndr's README