Compare commits
13 Commits
Author | SHA1 | Date | |
---|---|---|---|
62a24686f7 | |||
|
d10b550878 | ||
d67a852ae8 | |||
6cf8fe749d | |||
f626253b23 | |||
15a900b1bb | |||
098ffc1472 | |||
1acd61cff1 | |||
95effa7859 | |||
617b8880e4 | |||
|
3380d1a68e | ||
|
5ed0959cc4 | ||
|
f16a4574c1 |
@ -9,9 +9,8 @@ workspace:
|
|||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: test
|
- name: test
|
||||||
image: iamthefij/drone-pre-commit:latest
|
image: iamthefij/drone-pre-commit@sha256:6ed8dae6b0067bd2e145e36421bcfbbc68975ff7ddaa5a3f285b5bcdaf0989c8
|
||||||
commands:
|
commands:
|
||||||
- pip install docker-compose
|
|
||||||
- make all
|
- make all
|
||||||
|
|
||||||
- name: notify
|
- name: notify
|
||||||
|
@ -1,21 +1,7 @@
|
|||||||
---
|
---
|
||||||
- id: docker-compose-check
|
- id: docker-compose-check
|
||||||
name: Validate docker-compose files
|
name: Validate docker compose files
|
||||||
description: Checks that docker-compose files are valid
|
description: Checks that docker compose files are valid
|
||||||
language: script
|
language: script
|
||||||
entry: compose-check.sh
|
entry: compose-check.sh
|
||||||
files: docker-compose.y[a]{0,1}ml$
|
files: (docker-)?compose\.ya?ml$
|
||||||
|
|
||||||
- id: hadolint
|
|
||||||
name: Lint Dockerfiles
|
|
||||||
description: Deprecated! Runs hadolint Docker image to lint Dockerfiles
|
|
||||||
language: script
|
|
||||||
entry: hadolint-deprecation.sh
|
|
||||||
files: Dockerfile
|
|
||||||
|
|
||||||
- id: hadolint-system
|
|
||||||
name: Lint Dockerfiles
|
|
||||||
description: Deprecated! Runs system hadolint to lint Dockerfiles
|
|
||||||
language: script
|
|
||||||
entry: hadolint-deprecation.sh
|
|
||||||
files: Dockerfile
|
|
||||||
|
6
Makefile
6
Makefile
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
all: check test
|
all: check test
|
||||||
|
|
||||||
test: test-negative test-positive
|
test: test-negative test-positive test-hooks
|
||||||
|
|
||||||
.PHONY: test-positive
|
.PHONY: test-positive
|
||||||
test-positive:
|
test-positive:
|
||||||
@ -16,6 +16,10 @@ test-negative:
|
|||||||
@echo "Check multiple files. Should error."
|
@echo "Check multiple files. Should error."
|
||||||
./compose-check.sh tests/docker-compose* && { echo 'fail'; exit 1; } || echo 'ok'
|
./compose-check.sh tests/docker-compose* && { echo 'fail'; exit 1; } || echo 'ok'
|
||||||
|
|
||||||
|
.PHONY: test-hooks
|
||||||
|
test-hooks:
|
||||||
|
pre-commit try-repo . --all-files
|
||||||
|
|
||||||
# Installs pre-commit hooks
|
# Installs pre-commit hooks
|
||||||
.PHONY: install-hooks
|
.PHONY: install-hooks
|
||||||
install-hooks:
|
install-hooks:
|
||||||
|
19
README.md
19
README.md
@ -2,10 +2,21 @@
|
|||||||
|
|
||||||
A set of [pre-commit](http://pre-commit.com) hooks for Docker services
|
A set of [pre-commit](http://pre-commit.com) hooks for Docker services
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
Add the following to your `.pre-commit-config.yaml` file
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- repo: https://github.com/iamthefij/docker-pre-commit
|
||||||
|
rev: master
|
||||||
|
hooks:
|
||||||
|
- id: docker-compose-check
|
||||||
|
```
|
||||||
|
|
||||||
|
and then run `pre-commit autoupdate`.
|
||||||
|
|
||||||
|
|
||||||
## Hooks
|
## Hooks
|
||||||
|
|
||||||
### docker-compose-check
|
### docker-compose-check
|
||||||
Verifies that docker-compose files are valid by using `docker-compose config` to parse them.
|
Verifies that docker compose files are valid by using `docker compose config` to parse them.
|
||||||
|
|
||||||
### hadolint (Removed)
|
|
||||||
These hooks have been removed in favor of the ones that have been added to https://github.com/hadolint/hadolint
|
|
||||||
|
@ -2,28 +2,40 @@
|
|||||||
# Verifies that files passed in are valid for docker-compose
|
# Verifies that files passed in are valid for docker-compose
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
if command -v docker-compose &> /dev/null ; then
|
# Check if docker or podman commands are available
|
||||||
COMPOSE=docker-compose
|
if [[ -z "${CONTAINER_ENGINE}" ]]; then
|
||||||
elif command -v docker &> /dev/null && docker help compose &> /dev/null; then
|
if command -v docker &>/dev/null; then
|
||||||
COMPOSE=docker compose
|
CONTAINER_ENGINE=docker
|
||||||
|
elif command -v podman &>/dev/null; then
|
||||||
|
CONTAINER_ENGINE=podman
|
||||||
|
else
|
||||||
|
echo "ERROR: Neither 'docker' or 'podman' were found"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if command -v "${CONTAINER_ENGINE}" &>/dev/null && ${CONTAINER_ENGINE} help compose &> /dev/null; then
|
||||||
|
COMPOSE="${CONTAINER_ENGINE} compose"
|
||||||
|
elif command -v "${CONTAINER_ENGINE}-compose" &> /dev/null; then
|
||||||
|
COMPOSE="${CONTAINER_ENGINE}-compose"
|
||||||
else
|
else
|
||||||
echo "ERROR: Neither 'docker-compose' or 'docker compose' were found"
|
echo "ERROR: Neither '${CONTAINER_ENGINE}-compose' or '${CONTAINER_ENGINE} compose' were found"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
check_file() {
|
check_file() {
|
||||||
local file=$1
|
local file=$1
|
||||||
env $COMPOSE --file "$file" config --quiet 2>&1 \
|
env $COMPOSE --file "$file" config --quiet 2>&1 |
|
||||||
| sed "/variable is not set. Defaulting/d"
|
sed "/variable is not set. Defaulting/d"
|
||||||
return "${PIPESTATUS[0]}"
|
return "${PIPESTATUS[0]}"
|
||||||
}
|
}
|
||||||
|
|
||||||
check_files() {
|
check_files() {
|
||||||
local all_files=( "$@" )
|
local all_files=( "$@" )
|
||||||
has_error=0
|
has_error=0
|
||||||
for file in "${all_files[@]}" ; do
|
for file in "${all_files[@]}"; do
|
||||||
if [[ -f "$file" ]]; then
|
if [[ -f "$file" ]]; then
|
||||||
if ! check_file "$file" ; then
|
if ! check_file "$file"; then
|
||||||
echo "ERROR: $file"
|
echo "ERROR: $file"
|
||||||
has_error=1
|
has_error=1
|
||||||
fi
|
fi
|
||||||
@ -32,7 +44,7 @@ check_files() {
|
|||||||
return $has_error
|
return $has_error
|
||||||
}
|
}
|
||||||
|
|
||||||
if ! check_files "$@" ; then
|
if ! check_files "$@"; then
|
||||||
echo "Some compose files failed"
|
echo "Some compose files failed"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
@ -1,8 +0,0 @@
|
|||||||
#! /bin/sh
|
|
||||||
|
|
||||||
echo "Hadolint hooks have been deprecated in favor of upstream"
|
|
||||||
echo "repo: https://github.com/hadolint/hadolint"
|
|
||||||
echo "Replace hook 'hadolint' with 'hadolint-docker'"
|
|
||||||
echo "Replace hook 'hadolint-system' with 'hadolint'"
|
|
||||||
|
|
||||||
exit 1
|
|
Loading…
Reference in New Issue
Block a user