├── .gitignore ├── .github ├── dependabot.yml ├── labels.yml ├── workflows │ ├── release-drafter.yml │ ├── repository.yml │ ├── lint.yml │ ├── action_pull_request.yml │ ├── action_schedule.yml │ ├── action_branch.yml │ └── params.yml └── release-drafter.yml ├── .yamllint ├── LICENSE ├── Dockerfiles └── Dockerfile ├── Makefile └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | Makefile.docker 2 | Makefile.lint 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 2 3 | updates: 4 | # Maintain dependencies for GitHub Actions 5 | - package-ecosystem: "github-actions" 6 | directory: "/" 7 | schedule: 8 | interval: "daily" 9 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | --- 2 | extends: default 3 | 4 | ignore: | 5 | .yamllint 6 | 7 | 8 | rules: 9 | truthy: 10 | allowed-values: ['true', 'false'] 11 | check-keys: False 12 | level: error 13 | line-length: disable 14 | -------------------------------------------------------------------------------- /.github/labels.yml: -------------------------------------------------------------------------------- 1 | # The labels in this file are automatically synced with the repository 2 | # using the micnncim/action-label-syncer action. 3 | --- 4 | - name: C-dependency 5 | color: 1abc9c 6 | description: "Category: Dependency" 7 | - name: PR-block 8 | color: 3498db 9 | description: "Pull Request: Do not merge" 10 | - name: PR-merge 11 | color: 3498db 12 | description: "Pull Request: Merge when ready" 13 | -------------------------------------------------------------------------------- /.github/workflows/release-drafter.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Release Drafter 3 | 4 | on: 5 | push: 6 | # branches to consider in the event; optional, defaults to all 7 | branches: 8 | - master 9 | 10 | jobs: 11 | update_release_draft: 12 | runs-on: ubuntu-latest 13 | steps: 14 | # Drafts your next Release notes as Pull Requests are merged into "master" 15 | - uses: release-drafter/release-drafter@v5 16 | with: 17 | publish: true 18 | env: 19 | GITHUB_TOKEN: ${{ secrets.RELEASE_DRAFTER_TOKEN }} 20 | -------------------------------------------------------------------------------- /.github/workflows/repository.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Repository 3 | 4 | on: 5 | push: 6 | branches: 7 | - master 8 | paths: 9 | - .github/labels.yml 10 | 11 | jobs: 12 | labels: 13 | name: Labels 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - name: Checkout code 18 | uses: actions/checkout@v3 19 | 20 | - name: Sync labels 21 | uses: micnncim/action-label-syncer@v1 22 | env: 23 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 24 | with: 25 | manifest: .github/labels.yml 26 | -------------------------------------------------------------------------------- /.github/release-drafter.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name-template: '$RESOLVED_VERSION 🌈' 3 | tag-template: '$RESOLVED_VERSION' 4 | version-template: '$MAJOR.$MINOR' 5 | categories: 6 | - title: '🚀 Features' 7 | labels: 8 | - 'feature' 9 | - 'enhancement' 10 | - title: '🐛 Bug Fixes' 11 | labels: 12 | - 'fix' 13 | - 'bugfix' 14 | - 'bug' 15 | - title: '🧰 Maintenance' 16 | label: 'chore' 17 | change-template: '- $TITLE @$AUTHOR (#$NUMBER)' 18 | change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. 19 | version-resolver: 20 | major: 21 | labels: 22 | - 'major' 23 | minor: 24 | labels: 25 | - 'minor' 26 | patch: 27 | labels: 28 | - 'patch' 29 | default: minor 30 | template: | 31 | ## Changes 32 | 33 | $CHANGES 34 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: lint 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | # Runs on Pull Requests 14 | pull_request: 15 | 16 | 17 | # ------------------------------------------------------------------------------------------------- 18 | # What to run 19 | # ------------------------------------------------------------------------------------------------- 20 | jobs: 21 | lint: 22 | uses: devilbox/github-actions/.github/workflows/lint-generic.yml@master 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 cytopia 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/workflows/action_pull_request.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: build 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | pull_request: 14 | 15 | 16 | jobs: 17 | 18 | # (1/2) Determine repository params 19 | params: 20 | uses: ./.github/workflows/params.yml 21 | # Only run for forks (contributor) 22 | if: github.event.pull_request.head.repo.fork 23 | 24 | # (2/2) Build 25 | docker: 26 | needs: [params] 27 | uses: devilbox/github-actions/.github/workflows/docker-name-version-flavour-arch.yml@master 28 | with: 29 | enabled: true 30 | can_deploy: false 31 | matrix: ${{ needs.params.outputs.matrix }} 32 | refs: ${{ needs.params.outputs.refs }} 33 | secrets: 34 | dockerhub_username: "" 35 | dockerhub_password: "" 36 | -------------------------------------------------------------------------------- /.github/workflows/action_schedule.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: nightly 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | # Runs daily 14 | schedule: 15 | - cron: '0 0 * * *' 16 | 17 | 18 | jobs: 19 | 20 | # (1/2) Determine repository params 21 | params: 22 | uses: ./.github/workflows/params.yml 23 | 24 | # (2/2) Build 25 | docker: 26 | needs: [params] 27 | uses: devilbox/github-actions/.github/workflows/docker-name-version-flavour-arch.yml@master 28 | with: 29 | enabled: true 30 | can_deploy: true 31 | matrix: ${{ needs.params.outputs.matrix }} 32 | refs: ${{ needs.params.outputs.refs }} 33 | secrets: 34 | dockerhub_username: ${{ secrets.DOCKERHUB_USERNAME }} 35 | dockerhub_password: ${{ secrets.DOCKERHUB_PASSWORD }} 36 | -------------------------------------------------------------------------------- /Dockerfiles/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:latest as builder 2 | 3 | # Install dependencies 4 | RUN set -eux \ 5 | && DEBIAN_FRONTEND=noninteractive apt-get update -qq \ 6 | && DEBIAN_FRONTEND=noninteractive apt-get install -qq -y --no-install-recommends --no-install-suggests \ 7 | git \ 8 | gox \ 9 | pandoc \ 10 | && curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh 11 | 12 | # Get and build checkmake 13 | ARG VERSION 14 | ENV BUILDER_NAME=cytopia 15 | ENV BUILDER_EMAIL=cytopia@everythingcli.org 16 | RUN set -eux \ 17 | && export GOPATH=/go \ 18 | && mkdir -p /go/src/github.com/mrtazz \ 19 | && git clone https://github.com/mrtazz/checkmake /go/src/github.com/mrtazz/checkmake \ 20 | && cd /go/src/github.com/mrtazz/checkmake \ 21 | && if [ ${VERSION} != "latest" ]; then \ 22 | git checkout ${VERSION}; \ 23 | fi \ 24 | && make \ 25 | && chmod +x checkmake \ 26 | \ 27 | && ./checkmake --version | grep -E '^checkmake [0-9]+' 28 | 29 | # Use a clean tiny image to store artifacts in 30 | FROM alpine:3.16 31 | LABEL \ 32 | maintainer="cytopia " \ 33 | repo="https://github.com/cytopia/docker-checkmake" 34 | 35 | COPY --from=builder /go/src/github.com/mrtazz/checkmake/checkmake /usr/bin/checkmake 36 | 37 | WORKDIR /data 38 | ENTRYPOINT ["checkmake"] 39 | CMD ["--version"] 40 | -------------------------------------------------------------------------------- /.github/workflows/action_branch.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: build 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | push: 14 | paths: 15 | - 'Makefile' 16 | - 'Dockerfiles/**' 17 | - 'tests/**' 18 | - '.github/workflows/action*.yml' 19 | - '.github/workflows/params.yml' 20 | 21 | jobs: 22 | 23 | # (1/2) Determine repository params 24 | params: 25 | uses: ./.github/workflows/params.yml 26 | 27 | # (2/2) Build 28 | docker: 29 | needs: [params] 30 | uses: devilbox/github-actions/.github/workflows/docker-name-version-flavour-arch.yml@master 31 | with: 32 | enabled: true 33 | can_deploy: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/release-') }} 34 | matrix: ${{ needs.params.outputs.matrix }} 35 | refs: ${{ needs.params.outputs.refs }} 36 | secrets: 37 | dockerhub_username: ${{ secrets.DOCKERHUB_USERNAME }} 38 | dockerhub_password: ${{ secrets.DOCKERHUB_PASSWORD }} 39 | -------------------------------------------------------------------------------- /.github/workflows/params.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: params 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # Custom Variables 11 | # ------------------------------------------------------------------------------------------------- 12 | env: 13 | MATRIX: >- 14 | [ 15 | { 16 | "NAME": "checkmake", 17 | "VERSION": [ 18 | "latest" 19 | ], 20 | "FLAVOUR": ["latest"], 21 | "ARCH": ["linux/amd64", "linux/386", "linux/arm64", "linux/arm/v7", "linux/arm/v6", "linux/ppc64le", "linux/s390x"] 22 | } 23 | ] 24 | 25 | 26 | # ------------------------------------------------------------------------------------------------- 27 | # When to run 28 | # ------------------------------------------------------------------------------------------------- 29 | on: 30 | workflow_call: 31 | outputs: 32 | matrix: 33 | description: "The determined version matrix" 34 | value: ${{ jobs.params.outputs.matrix }} 35 | refs: 36 | description: "The determined git ref matrix (only during scheduled run)" 37 | value: ${{ jobs.params.outputs.refs }} 38 | 39 | jobs: 40 | params: 41 | runs-on: ubuntu-latest 42 | 43 | outputs: 44 | matrix: ${{ steps.set-matrix.outputs.matrix }} 45 | refs: ${{ steps.set-refs.outputs.matrix }} 46 | 47 | steps: 48 | - name: "[Set-Output] Matrix" 49 | id: set-matrix 50 | run: | 51 | echo "matrix=$( echo '${{ env.MATRIX }}' | jq -M -c )" >> $GITHUB_OUTPUT 52 | 53 | - name: "[Set-Output] Matrix 'Refs' (master branch and latest tag)" 54 | id: set-refs 55 | uses: cytopia/git-ref-matrix-action@v0.1.13 56 | with: 57 | repository_default_branch: master 58 | branches: master 59 | num_latest_tags: 0 60 | if: github.event_name == 'schedule' 61 | 62 | - name: "[DEBUG] Show settings'" 63 | run: | 64 | echo 'Matrix' 65 | echo '--------------------' 66 | echo '${{ steps.set-matrix.outputs.matrix }}' 67 | echo 68 | 69 | echo 'Matrix: Refs' 70 | echo '--------------------' 71 | echo '${{ steps.set-matrix-refs.outputs.matrix }}' 72 | echo 73 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ifneq (,) 2 | .error This Makefile requires GNU Make. 3 | endif 4 | 5 | # Ensure additional Makefiles are present 6 | MAKEFILES = Makefile.docker Makefile.lint 7 | $(MAKEFILES): URL=https://raw.githubusercontent.com/devilbox/makefiles/master/$(@) 8 | $(MAKEFILES): 9 | @if ! (curl --fail -sS -o $(@) $(URL) || wget -O $(@) $(URL)); then \ 10 | echo "Error, curl or wget required."; \ 11 | echo "Exiting."; \ 12 | false; \ 13 | fi 14 | include $(MAKEFILES) 15 | 16 | # Set default Target 17 | .DEFAULT_GOAL := help 18 | 19 | 20 | # ------------------------------------------------------------------------------------------------- 21 | # Default configuration 22 | # ------------------------------------------------------------------------------------------------- 23 | # Own vars 24 | TAG = latest 25 | 26 | # Makefile.docker overwrites 27 | NAME = checkmake 28 | VERSION = latest 29 | IMAGE = cytopia/checkmake 30 | FLAVOUR = latest 31 | DIR = Dockerfiles 32 | 33 | FILE = Dockerfile 34 | 35 | # Building from master branch: Tag == 'latest' 36 | ifeq ($(strip $(TAG)),latest) 37 | ifeq ($(strip $(VERSION)),latest) 38 | DOCKER_TAG = latest 39 | else 40 | DOCKER_TAG = $(VERSION) 41 | endif 42 | # Building from any other branch or tag: Tag == '' 43 | else 44 | ifeq ($(strip $(VERSION)),latest) 45 | DOCKER_TAG = latest-$(TAG) 46 | else 47 | DOCKER_TAG = $(VERSION)-$(TAG) 48 | endif 49 | endif 50 | 51 | # Makefile.lint overwrites 52 | FL_IGNORES = .git/,.github/ 53 | SC_IGNORES = .git/,.github/ 54 | JL_IGNORES = .git/,.github/ 55 | 56 | 57 | # ------------------------------------------------------------------------------------------------- 58 | # Default Target 59 | # ------------------------------------------------------------------------------------------------- 60 | .PHONY: help 61 | help: 62 | @echo "lint Lint project files and repository" 63 | @echo 64 | @echo "build [ARCH=...] [TAG=...] Build Docker image" 65 | @echo "rebuild [ARCH=...] [TAG=...] Build Docker image without cache" 66 | @echo "push [ARCH=...] [TAG=...] Push Docker image to Docker hub" 67 | @echo 68 | @echo "manifest-create [ARCHES=...] [TAG=...] Create multi-arch manifest" 69 | @echo "manifest-push [TAG=...] Push multi-arch manifest" 70 | @echo 71 | @echo "test [ARCH=...] Test built Docker image" 72 | @echo 73 | 74 | 75 | # ------------------------------------------------------------------------------------------------- 76 | # Docker Targets 77 | # ------------------------------------------------------------------------------------------------- 78 | .PHONY: build 79 | build: ARGS+=--build-arg VERSION=$(VERSION) 80 | build: docker-arch-build 81 | 82 | .PHONY: rebuild 83 | rebuild: ARGS+=--build-arg VERSION=$(VERSION) 84 | rebuild: docker-arch-rebuild 85 | 86 | .PHONY: push 87 | push: docker-arch-push 88 | 89 | 90 | # ------------------------------------------------------------------------------------------------- 91 | # Manifest Targets 92 | # ------------------------------------------------------------------------------------------------- 93 | .PHONY: manifest-create 94 | manifest-create: docker-manifest-create 95 | 96 | .PHONY: manifest-push 97 | manifest-push: docker-manifest-push 98 | 99 | 100 | # ------------------------------------------------------------------------------------------------- 101 | # Test Targets 102 | # ------------------------------------------------------------------------------------------------- 103 | .PHONY: test 104 | test: _test-version 105 | 106 | .PHONY: _test-version 107 | _test-version: 108 | @echo "------------------------------------------------------------" 109 | @echo "- Testing correct version" 110 | @echo "------------------------------------------------------------" 111 | @if [ "$(VERSION)" = "latest" ]; then \ 112 | echo "Fetching latest version from GitHub"; \ 113 | LATEST="$$( \ 114 | curl -L -sS https://github.com/mrtazz/checkmake/releases/latest/ \ 115 | | tac | tac \ 116 | | grep -Eo "mrtazz/checkmake/releases/tag/[.0-9]+" \ 117 | | head -1 \ 118 | | sed 's/.*tag\///g' \ 119 | )"; \ 120 | echo "Testing for latest: $${LATEST}"; \ 121 | if ! docker run --rm --platform $(ARCH) $(IMAGE):$(DOCKER_TAG) | grep -E "^checkmake $${LATEST}"; then \ 122 | docker run --rm --platform $(ARCH) $(IMAGE):$(DOCKER_TAG); \ 123 | echo "Failed"; \ 124 | exit 1; \ 125 | fi; \ 126 | else \ 127 | echo "Testing for tag: $(VERSION)"; \ 128 | if ! docker run --rm --platform $(ARCH) $(IMAGE):$(DOCKER_TAG) | grep -E "^checkmake $(VERSION)"; then \ 129 | docker run --rm --platform $(ARCH) $(IMAGE):$(DOCKER_TAG); \ 130 | echo "Failed"; \ 131 | exit 1; \ 132 | fi; \ 133 | fi; \ 134 | echo "Success"; \ 135 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Docker image for `checkmake` 2 | 3 | [![Tag](https://img.shields.io/github/tag/cytopia/docker-checkmake.svg)](https://github.com/cytopia/docker-checkmake/releases) 4 | [![](https://img.shields.io/badge/github-cytopia%2Fdocker--checkmake-red.svg)](https://github.com/cytopia/docker-checkmake "github.com/cytopia/docker-checkmake") 5 | [![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT) 6 | 7 | [![lint](https://github.com/cytopia/docker-checkmake/workflows/lint/badge.svg)](https://github.com/cytopia/docker-checkmake/actions?query=workflow%3Alint) 8 | [![build](https://github.com/cytopia/docker-checkmake/workflows/build/badge.svg)](https://github.com/cytopia/docker-checkmake/actions?query=workflow%3Abuild) 9 | [![nightly](https://github.com/cytopia/docker-checkmake/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-checkmake/actions?query=workflow%3Anightly) 10 | 11 | 12 | > #### All [#awesome-ci](https://github.com/topics/awesome-ci) Docker images 13 | > 14 | > [ansible-lint][alint-git-lnk] **•** 15 | > [ansible][ansible-git-lnk] **•** 16 | > [awesome-ci][aci-git-lnk] **•** 17 | > [bandit][bandit-git-lnk] **•** 18 | > [black][black-git-lnk] **•** 19 | > [checkmake][cm-git-lnk] **•** 20 | > [eslint][elint-git-lnk] **•** 21 | > [file-lint][flint-git-lnk] **•** 22 | > [gofmt][gfmt-git-lnk] **•** 23 | > [goimports][gimp-git-lnk] **•** 24 | > [golint][glint-git-lnk] **•** 25 | > [jsonlint][jlint-git-lnk] **•** 26 | > [kubeval][kubeval-git-lnk] **•** 27 | > [linkcheck][linkcheck-git-lnk] **•** 28 | > [mypy][mypy-git-lnk] **•** 29 | > [php-cs-fixer][pcsf-git-lnk] **•** 30 | > [phpcbf][pcbf-git-lnk] **•** 31 | > [phpcs][pcs-git-lnk] **•** 32 | > [phplint][plint-git-lnk] **•** 33 | > [pycodestyle][pycs-git-lnk] **•** 34 | > [pydocstyle][pyds-git-lnk] **•** 35 | > [pylint][pylint-git-lnk] **•** 36 | > [terraform-docs][tfdocs-git-lnk] **•** 37 | > [terragrunt-fmt][tgfmt-git-lnk] **•** 38 | > [terragrunt][tg-git-lnk] **•** 39 | > [yamlfmt][yfmt-git-lnk] **•** 40 | > [yamllint][ylint-git-lnk] 41 | 42 | View **[Dockerfiles](https://github.com/cytopia/docker-checkmake/blob/master/Dockerfiles/)** on GitHub. 43 | 44 | 45 | **Available Architectures:** `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`, `ppc64le`, `s390x` 46 | 47 | Tiny Alpine-based multistage-build dockerized version of [checkmake](https://github.com/mrtazz/checkmake)[1], 48 | The image is built nightly against multiple stable versions and pushed to Dockerhub. 49 | 50 | [1] Official project: https://github.com/mrtazz/checkmake 51 | 52 | ## :whale: Available Docker image versions 53 | 54 | [![](https://img.shields.io/docker/pulls/cytopia/checkmake.svg)](https://hub.docker.com/r/cytopia/checkmake) 55 | [![Docker](https://badgen.net/badge/icon/:latest?icon=docker&label=cytopia/checkmake)](https://hub.docker.com/r/cytopia/checkmake) 56 | 57 | #### Rolling releaess 58 | 59 | The following Docker image tags are rolling releases and are built and updated every night. 60 | 61 | [![nightly](https://github.com/cytopia/docker-checkmake/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-checkmake/actions?query=workflow%3Anightly) 62 | 63 | | Docker Tag | Git Ref | checkmake | Available Architectures | 64 | |----------------------|-----------|--------------|----------------------------------------------| 65 | | `latest` | master | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`, `ppc64le`, `s390x` | 66 | 67 | #### Point in time releases 68 | 69 | The following Docker image tags are built once and can be used for reproducible builds. Its version never changes so you will have to update tags in your pipelines from time to time in order to stay up-to-date. 70 | 71 | [![build](https://github.com/cytopia/docker-checkmake/workflows/build/badge.svg)](https://github.com/cytopia/docker-checkmake/actions?query=workflow%3Abuild) 72 | 73 | | Docker Tag | Git Ref | checkmake | Available Architectures | 74 | |----------------------|--------------|--------------|----------------------------------------------| 75 | | `latest-` | tag: `` | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`, `ppc64le`, `s390x` | 76 | 77 | > Where `` refers to the chosen git tag from this repository. 78 | 79 | 80 | ## :open_file_folder: Docker mounts 81 | 82 | The working directory inside the Docker container is **`/data/`** and should be mounted locally to 83 | the root of your project. 84 | 85 | 86 | ## :computer: Usage 87 | 88 | ### Generic 89 | ```bash 90 | # Lint a single Makefile 91 | docker run --rm -v $(pwd):/data cytopia/checkmake Makefile 92 | 93 | # Lint all available Makefiles 94 | docker run --rm -v $(pwd):/data --entrypoint=find cytopia/checkmake . -name Makefile -exec checkmake {} \; 95 | ``` 96 | 97 | ### Configuration 98 | 99 | If you want to change the behaviour of `checkmake`, you can add `checkmake.ini` to the root of your 100 | mount location and adjust the linter settings: 101 | ```ini 102 | [maxbodylength] 103 | maxBodyLength = 10 104 | 105 | [minphony] 106 | disabled = true 107 | ``` 108 | 109 | 110 | ## :arrows_counterclockwise: Related [#awesome-ci](https://github.com/topics/awesome-ci) projects 111 | 112 | ### Docker images 113 | 114 | Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite 115 | linter below for reproducible local or remote CI tests: 116 | 117 | | GitHub | DockerHub | Type | Description | 118 | |--------|-----------|------|-------------| 119 | | [awesome-ci][aci-git-lnk] | [![aci-hub-img]][aci-hub-lnk] | Basic | Tools for git, file and static source code analysis | 120 | | [file-lint][flint-git-lnk] | [![flint-hub-img]][flint-hub-lnk] | Basic | Baisc source code analysis | 121 | | [linkcheck][linkcheck-git-lnk] | [![linkcheck-hub-img]][flint-hub-lnk] | Basic | Search for URLs in files and validate their HTTP status code | 122 | | [ansible][ansible-git-lnk] | [![ansible-hub-img]][ansible-hub-lnk] | Ansible | Multiple versions and flavours of Ansible | 123 | | [ansible-lint][alint-git-lnk] | [![alint-hub-img]][alint-hub-lnk] | Ansible | Lint Ansible | 124 | | [gofmt][gfmt-git-lnk] | [![gfmt-hub-img]][gfmt-hub-lnk] | Go | Format Go source code **[1]** | 125 | | [goimports][gimp-git-lnk] | [![gimp-hub-img]][gimp-hub-lnk] | Go | Format Go source code **[1]** | 126 | | [golint][glint-git-lnk] | [![glint-hub-img]][glint-hub-lnk] | Go | Lint Go code | 127 | | [eslint][elint-git-lnk] | [![elint-hub-img]][elint-hub-lnk] | Javascript | Lint Javascript code | 128 | | [jsonlint][jlint-git-lnk] | [![jlint-hub-img]][jlint-hub-lnk] | JSON | Lint JSON files **[1]** | 129 | | [kubeval][kubeval-git-lnk] | [![kubeval-hub-img]][kubeval-hub-lnk] | K8s | Lint Kubernetes files | 130 | | [checkmake][cm-git-lnk] | [![cm-hub-img]][cm-hub-lnk] | Make | Lint Makefiles | 131 | | [phpcbf][pcbf-git-lnk] | [![pcbf-hub-img]][pcbf-hub-lnk] | PHP | PHP Code Beautifier and Fixer | 132 | | [phpcs][pcs-git-lnk] | [![pcs-hub-img]][pcs-hub-lnk] | PHP | PHP Code Sniffer | 133 | | [phplint][plint-git-lnk] | [![plint-hub-img]][plint-hub-lnk] | PHP | PHP Code Linter **[1]** | 134 | | [php-cs-fixer][pcsf-git-lnk] | [![pcsf-hub-img]][pcsf-hub-lnk] | PHP | PHP Coding Standards Fixer | 135 | | [bandit][bandit-git-lnk] | [![bandit-hub-img]][bandit-hub-lnk] | Python | A security linter from PyCQA 136 | | [black][black-git-lnk] | [![black-hub-img]][black-hub-lnk] | Python | The uncompromising Python code formatter | 137 | | [mypy][mypy-git-lnk] | [![mypy-hub-img]][mypy-hub-lnk] | Python | Static source code analysis | 138 | | [pycodestyle][pycs-git-lnk] | [![pycs-hub-img]][pycs-hub-lnk] | Python | Python style guide checker | 139 | | [pydocstyle][pyds-git-lnk] | [![pyds-hub-img]][pyds-hub-lnk] | Python | Python docstyle checker | 140 | | [pylint][pylint-git-lnk] | [![pylint-hub-img]][pylint-hub-lnk] | Python | Python source code, bug and quality checker | 141 | | [terraform-docs][tfdocs-git-lnk] | [![tfdocs-hub-img]][tfdocs-hub-lnk] | Terraform | Terraform doc generator (TF 0.12 ready) **[1]** | 142 | | [terragrunt][tg-git-lnk] | [![tg-hub-img]][tg-hub-lnk] | Terraform | Terragrunt and Terraform | 143 | | [terragrunt-fmt][tgfmt-git-lnk] | [![tgfmt-hub-img]][tgfmt-hub-lnk] | Terraform | `terraform fmt` for Terragrunt files **[1]** | 144 | | [yamlfmt][yfmt-git-lnk] | [![yfmt-hub-img]][yfmt-hub-lnk] | Yaml | Format Yaml files **[1]** | 145 | | [yamllint][ylint-git-lnk] | [![ylint-hub-img]][ylint-hub-lnk] | Yaml | Lint Yaml files | 146 | 147 | > **[1]** Uses a shell wrapper to add **enhanced functionality** not available by original project. 148 | 149 | [aci-git-lnk]: https://github.com/cytopia/awesome-ci 150 | [aci-hub-img]: https://img.shields.io/docker/pulls/cytopia/awesome-ci.svg 151 | [aci-hub-lnk]: https://hub.docker.com/r/cytopia/awesome-ci 152 | 153 | [flint-git-lnk]: https://github.com/cytopia/docker-file-lint 154 | [flint-hub-img]: https://img.shields.io/docker/pulls/cytopia/file-lint.svg 155 | [flint-hub-lnk]: https://hub.docker.com/r/cytopia/file-lint 156 | 157 | [linkcheck-git-lnk]: https://github.com/cytopia/docker-linkcheck 158 | [linkcheck-hub-img]: https://img.shields.io/docker/pulls/cytopia/linkcheck.svg 159 | [linkcheck-hub-lnk]: https://hub.docker.com/r/cytopia/linkcheck 160 | 161 | [jlint-git-lnk]: https://github.com/cytopia/docker-jsonlint 162 | [jlint-hub-img]: https://img.shields.io/docker/pulls/cytopia/jsonlint.svg 163 | [jlint-hub-lnk]: https://hub.docker.com/r/cytopia/jsonlint 164 | 165 | [ansible-git-lnk]: https://github.com/cytopia/docker-ansible 166 | [ansible-hub-img]: https://img.shields.io/docker/pulls/cytopia/ansible.svg 167 | [ansible-hub-lnk]: https://hub.docker.com/r/cytopia/ansible 168 | 169 | [alint-git-lnk]: https://github.com/cytopia/docker-ansible-lint 170 | [alint-hub-img]: https://img.shields.io/docker/pulls/cytopia/ansible-lint.svg 171 | [alint-hub-lnk]: https://hub.docker.com/r/cytopia/ansible-lint 172 | 173 | [kubeval-git-lnk]: https://github.com/cytopia/docker-kubeval 174 | [kubeval-hub-img]: https://img.shields.io/docker/pulls/cytopia/kubeval.svg 175 | [kubeval-hub-lnk]: https://hub.docker.com/r/cytopia/kubeval 176 | 177 | [gfmt-git-lnk]: https://github.com/cytopia/docker-gofmt 178 | [gfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/gofmt.svg 179 | [gfmt-hub-lnk]: https://hub.docker.com/r/cytopia/gofmt 180 | 181 | [gimp-git-lnk]: https://github.com/cytopia/docker-goimports 182 | [gimp-hub-img]: https://img.shields.io/docker/pulls/cytopia/goimports.svg 183 | [gimp-hub-lnk]: https://hub.docker.com/r/cytopia/goimports 184 | 185 | [glint-git-lnk]: https://github.com/cytopia/docker-golint 186 | [glint-hub-img]: https://img.shields.io/docker/pulls/cytopia/golint.svg 187 | [glint-hub-lnk]: https://hub.docker.com/r/cytopia/golint 188 | 189 | [elint-git-lnk]: https://github.com/cytopia/docker-eslint 190 | [elint-hub-img]: https://img.shields.io/docker/pulls/cytopia/eslint.svg 191 | [elint-hub-lnk]: https://hub.docker.com/r/cytopia/eslint 192 | 193 | [cm-git-lnk]: https://github.com/cytopia/docker-checkmake 194 | [cm-hub-img]: https://img.shields.io/docker/pulls/cytopia/checkmake.svg 195 | [cm-hub-lnk]: https://hub.docker.com/r/cytopia/checkmake 196 | 197 | [pcbf-git-lnk]: https://github.com/cytopia/docker-phpcbf 198 | [pcbf-hub-img]: https://img.shields.io/docker/pulls/cytopia/phpcbf.svg 199 | [pcbf-hub-lnk]: https://hub.docker.com/r/cytopia/phpcbf 200 | 201 | [pcs-git-lnk]: https://github.com/cytopia/docker-phpcs 202 | [pcs-hub-img]: https://img.shields.io/docker/pulls/cytopia/phpcs.svg 203 | [pcs-hub-lnk]: https://hub.docker.com/r/cytopia/phpcs 204 | 205 | [plint-git-lnk]: https://github.com/cytopia/docker-phplint 206 | [plint-hub-img]: https://img.shields.io/docker/pulls/cytopia/phplint.svg 207 | [plint-hub-lnk]: https://hub.docker.com/r/cytopia/phplint 208 | 209 | [pcsf-git-lnk]: https://github.com/cytopia/docker-php-cs-fixer 210 | [pcsf-hub-img]: https://img.shields.io/docker/pulls/cytopia/php-cs-fixer.svg 211 | [pcsf-hub-lnk]: https://hub.docker.com/r/cytopia/php-cs-fixer 212 | 213 | [bandit-git-lnk]: https://github.com/cytopia/docker-bandit 214 | [bandit-hub-img]: https://img.shields.io/docker/pulls/cytopia/bandit.svg 215 | [bandit-hub-lnk]: https://hub.docker.com/r/cytopia/bandit 216 | 217 | [black-git-lnk]: https://github.com/cytopia/docker-black 218 | [black-hub-img]: https://img.shields.io/docker/pulls/cytopia/black.svg 219 | [black-hub-lnk]: https://hub.docker.com/r/cytopia/black 220 | 221 | [mypy-git-lnk]: https://github.com/cytopia/docker-mypy 222 | [mypy-hub-img]: https://img.shields.io/docker/pulls/cytopia/mypy.svg 223 | [mypy-hub-lnk]: https://hub.docker.com/r/cytopia/mypy 224 | 225 | [pycs-git-lnk]: https://github.com/cytopia/docker-pycodestyle 226 | [pycs-hub-img]: https://img.shields.io/docker/pulls/cytopia/pycodestyle.svg 227 | [pycs-hub-lnk]: https://hub.docker.com/r/cytopia/pycodestyle 228 | 229 | [pyds-git-lnk]: https://github.com/cytopia/docker-pydocstyle 230 | [pyds-hub-img]: https://img.shields.io/docker/pulls/cytopia/pydocstyle.svg 231 | [pyds-hub-lnk]: https://hub.docker.com/r/cytopia/pydocstyle 232 | 233 | [pylint-git-lnk]: https://github.com/cytopia/docker-pylint 234 | [pylint-hub-img]: https://img.shields.io/docker/pulls/cytopia/pylint.svg 235 | [pylint-hub-lnk]: https://hub.docker.com/r/cytopia/pylint 236 | 237 | [tfdocs-git-lnk]: https://github.com/cytopia/docker-terraform-docs 238 | [tfdocs-hub-img]: https://img.shields.io/docker/pulls/cytopia/terraform-docs.svg 239 | [tfdocs-hub-lnk]: https://hub.docker.com/r/cytopia/terraform-docs 240 | 241 | [tg-git-lnk]: https://github.com/cytopia/docker-terragrunt 242 | [tg-hub-img]: https://img.shields.io/docker/pulls/cytopia/terragrunt.svg 243 | [tg-hub-lnk]: https://hub.docker.com/r/cytopia/terragrunt 244 | 245 | [tgfmt-git-lnk]: https://github.com/cytopia/docker-terragrunt-fmt 246 | [tgfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/terragrunt-fmt.svg 247 | [tgfmt-hub-lnk]: https://hub.docker.com/r/cytopia/terragrunt-fmt 248 | 249 | [yfmt-git-lnk]: https://github.com/cytopia/docker-yamlfmt 250 | [yfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/yamlfmt.svg 251 | [yfmt-hub-lnk]: https://hub.docker.com/r/cytopia/yamlfmt 252 | 253 | [ylint-git-lnk]: https://github.com/cytopia/docker-yamllint 254 | [ylint-hub-img]: https://img.shields.io/docker/pulls/cytopia/yamllint.svg 255 | [ylint-hub-lnk]: https://hub.docker.com/r/cytopia/yamllint 256 | 257 | 258 | ### Makefiles 259 | 260 | Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for dependency-less, seamless project integration and minimum required best-practice code linting for CI. 261 | The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else. 262 | 263 | 264 | ## :page_facing_up: License 265 | 266 | 267 | **[MIT License](LICENSE)** 268 | 269 | Copyright (c) 2019 [cytopia](https://github.com/cytopia) 270 | --------------------------------------------------------------------------------