Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ that should get you started.
`docker-compose` from anywhere on your machine, it will run your development
version of Compose.

## Install pre-commit hooks

This step is optional, but recommended. Pre-commit hooks will run style checks
and in some cases fix style issues for you, when you commit code.

Install the git pre-commit hooks using [tox](https://tox.readthedocs.org) by
running `tox -e pre-commit` or by following the
[pre-commit install guide](http://pre-commit.com/#install).

To run the style checks at any time run `tox -e pre-commit`.

## Submitting a pull request

See Docker's [basic contribution workflow](https://docs.docker.com/project/make-a-contribution/#the-basic-contribution-workflow) for a guide on how to submit a pull request for code or documentation.
Expand Down
1 change: 1 addition & 0 deletions script/ci
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ set -e

export DOCKER_VERSIONS=all
export DOCKER_DAEMON_ARGS="--storage-driver=overlay"
GIT_VOLUME="--volumes-from=$(hostname)"
. script/test-versions

>&2 echo "Building Linux binary"
Expand Down
15 changes: 5 additions & 10 deletions script/test
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,10 @@ set -ex
TAG="docker-compose:$(git rev-parse --short HEAD)"

rm -rf coverage-html
# Create the host directory so it's owned by $USER
mkdir -p coverage-html

docker build -t "$TAG" .
docker run \
--rm \
--volume="/var/run/docker.sock:/var/run/docker.sock" \
-e DOCKER_VERSIONS \
-e "TAG=$TAG" \
-e "affinity:image==$TAG" \
-e "COVERAGE_DIR=$(pwd)/coverage-html" \
--entrypoint="script/test-versions" \
"$TAG" \
"$@"

GIT_VOLUME="--volume=$(pwd)/.git:/code/.git"
. script/test-versions
5 changes: 4 additions & 1 deletion script/test-versions
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
set -e

>&2 echo "Running lint checks"
tox -e pre-commit
docker run --rm \
${GIT_VOLUME} \
--entrypoint="tox" \
"$TAG" -e pre-commit

if [ "$DOCKER_VERSIONS" == "" ]; then
DOCKER_VERSIONS="default"
Expand Down