beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
moby/hack
History
Abhishek Sharma 99c1456647
Adding a README.md for the hack folder. 
Signed-off-by: Abhishek Sharma <abhishek@asharma.me>
2017-05-15 17:06:35 +02:00
..
dockerfile Change log details encoding format and support details on service logs 2017-05-12 10:53:44 -07:00
integration-cli-on-swarm Merge pull request #31683 from AkihiroSuda/it-on-swarm-easy-analysis 2017-03-28 15:50:52 +02:00
Jenkins Update docker daemon to dockerd 2016-12-27 17:32:15 +08:00
make Merge pull request #32437 from cpuguy83/container_selinux 2017-05-12 09:23:17 -04: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 Build client on Windows in a temporary directory 2017-05-10 11:45:10 -07: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

README.md

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