Compare commits

...

22 Commits

Author SHA1 Message Date
62a24686f7 Merge branch 'cdalvaro/podman_support'
Some checks failed
continuous-integration/drone/push Build is failing
Closes #16
2024-06-24 11:36:03 -07:00
Carlos Álvaro
d10b550878
feat: Add podman support 2024-05-12 18:50:33 +02:00
d67a852ae8 Add test hooks with try-repo
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-26 14:56:42 -07:00
6cf8fe749d Use personal drone-pre-commit image that has docker-compose binary installed
All checks were successful
continuous-integration/drone/push Build is passing
2023-10-26 14:53:53 -07:00
f626253b23 Fix regex to match a literal dot before extension
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
Also simplifies the optional a match a bit.

Fixes #15
2023-04-19 09:19:08 -07:00
15a900b1bb Use compose plugin language in documentation 2023-04-19 09:18:55 -07:00
098ffc1472 Remove hadolint completely (inclusing script)
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-18 17:19:44 -07:00
1acd61cff1 Remove hadolint completely
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2023-04-18 17:18:48 -07:00
95effa7859 Add installation instructions
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
Fixes #11
2023-04-18 17:17:43 -07:00
617b8880e4 Merge branch 'update-docker-compose-regex' of github.com:claha/docker-pre-commit into claha-update-docker-compose-regex
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-18 17:13:18 -07:00
M. R
3380d1a68e
Prefer docker compose v2
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-14 12:35:01 +01:00
Claes Hallström
5ed0959cc4 Update regex to also detect compose.yaml files
According to the new compose specification, compose.yaml is the
preferred file name.
2023-04-08 23:30:53 +02:00
Alex Hafner
f16a4574c1
wrap "docker compose" command in quotes
Some checks failed
continuous-integration/drone/push Build is failing
continuous-integration/drone/tag Build is failing
2022-05-19 12:28:39 +01:00
71cd8ff86a Update compose-check to suport compose subcommand
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2022-03-04 15:57:05 -08:00
5a0378fee5 Remove hadolint and add deprecation notice
All checks were successful
continuous-integration/drone/push Build is passing
2021-04-09 10:11:11 -07:00
9a22a2046c Merge remote-tracking branch 'github/master'
All checks were successful
continuous-integration/drone/push Build is passing
2021-04-07 08:44:14 -07:00
67b85ce990 Remove no-verify recommendation
Fixes #2
2021-04-07 08:42:35 -07:00
86d69eafb9
Merge pull request #1 from lkwg82/patch-1
fixes link to hadolint
2021-04-06 10:40:27 -07:00
aeda358a4a Change drone steps
All checks were successful
continuous-integration/drone/push Build is passing
2020-09-19 21:26:29 +00:00
5c7dc7758b Add pre-commit hooks of our own
Some checks failed
continuous-integration/drone/push Build is failing
Adds some basic near-universal checks and shellcheck
2020-09-19 20:07:34 +00:00
9a0ea5ca85 Expand command line flags 2020-09-19 19:57:38 +00:00
Lars K.W. Gohlke
6cf90c5656
fixes link to hadolint 2020-09-13 19:35:08 +02:00
6 changed files with 77 additions and 39 deletions

View File

@ -9,11 +9,8 @@ workspace:
steps: steps:
- name: test - name: test
image: python:3-slim image: iamthefij/drone-pre-commit@sha256:6ed8dae6b0067bd2e145e36421bcfbbc68975ff7ddaa5a3f285b5bcdaf0989c8
commands: commands:
- apt-get update
- apt-get install -y --no-install-recommends make shellcheck
- pip install docker-compose
- make all - make all
- name: notify - name: notify

14
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,14 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
args:
- --allow-multiple-documents
- id: check-merge-conflict
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.7.1.1
hooks:
- id: shellcheck

View File

@ -1,19 +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: Runs hadolint Docker image to lint Dockerfiles
language: docker_image
entry: hadolint/hadolint hadolint
files: Dockerfile
- id: hadolint-system
name: Lint Dockerfiles
description: Runs system hadolint to lint Dockerfiles
language: system
entry: hadolint
files: Dockerfile

View File

@ -1,12 +1,8 @@
.PHONY: all test clean .PHONY: all test clean
all: test shellcheck all: check test
test: test-negative test-positive test: test-negative test-positive test-hooks
.PHONY: shellcheck
shellcheck:
shellcheck *.sh
.PHONY: test-positive .PHONY: test-positive
test-positive: test-positive:
@ -19,3 +15,17 @@ test-negative:
./compose-check.sh tests/docker-compose.bad.yml && { echo 'fail'; exit 1; } || echo 'ok' ./compose-check.sh tests/docker-compose.bad.yml && { echo 'fail'; exit 1; } || echo 'ok'
@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
.PHONY: install-hooks
install-hooks:
pre-commit install --install-hooks
# Checks files for encryption
.PHONY: check
check:
pre-commit run --all-files

View File

@ -2,13 +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
Uses the [hadolint Docker image](https://hub.docker.com/hadolint/hadolint) to lint Dockerfiles.
### hadolint-system
Uses the whatever version of hadolint that you have installed to lint Dockerfiles. This requires you to have hadolint installed somewhere in your path.

View File

@ -1,20 +1,41 @@
#! /bin/bash #! /usr/bin/env bash
# Verifies that files passed in are valid for docker-compose # Verifies that files passed in are valid for docker-compose
set -e set -e
# Check if docker or podman commands are available
if [[ -z "${CONTAINER_ENGINE}" ]]; then
if command -v docker &>/dev/null; then
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
echo "ERROR: Neither '${CONTAINER_ENGINE}-compose' or '${CONTAINER_ENGINE} compose' were found"
exit 1
fi
check_file() { check_file() {
local file=$1 local file=$1
docker-compose -f "$file" config -q 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
@ -23,8 +44,8 @@ check_files() {
return $has_error return $has_error
} }
if ! check_files "$@" ; then if ! check_files "$@"; then
echo "To ignore, use --no-verify" echo "Some compose files failed"
fi fi
exit $has_error exit $has_error