diff --git a/README.md b/README.md index 05624cb..5171e11 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,189 @@ [![Docker image](https://images.microbadger.com/badges/image/cytopia/awesome-ci.svg)](https://hub.docker.com/r/cytopia/awesome-ci) [![License](https://poser.pugx.org/cytopia/awesome-ci/license)](http://opensource.org/licenses/MIT) + +> ## :warning: DEPRECATION WARNING +> +> This repository is deprecated. Please use the following docker images below instead: +> > #### All [#awesome-ci](https://github.com/topics/awesome-ci) Docker images > -> [ansible](https://github.com/cytopia/docker-ansible) **•** -> [ansible-lint](https://github.com/cytopia/docker-ansible-lint) **•** -> [awesome-ci](https://github.com/cytopia/awesome-ci) **•** -> [black](https://github.com/cytopia/docker-black) **•** -> [checkmake](https://github.com/cytopia/docker-checkmake) **•** -> [eslint](https://github.com/cytopia/docker-eslint) **•** -> [file-lint](https://github.com/cytopia/docker-file-lint) **•** -> [gofmt](https://github.com/cytopia/docker-gofmt) **•** -> [golint](https://github.com/cytopia/docker-golint) **•** -> [jsonlint](https://github.com/cytopia/docker-jsonlint) **•** -> [phpcs](https://github.com/cytopia/docker-phpcs) **•** -> [pycodestyle](https://github.com/cytopia/docker-pycodestyle) **•** -> [pylint](https://github.com/cytopia/docker-pylint) **•** -> [terraform-docs](https://github.com/cytopia/docker-terraform-docs) **•** -> [terragrunt](https://github.com/cytopia/docker-terragrunt) **•** -> [yamllint](https://github.com/cytopia/docker-yamllint) - - -> #### All [#awesome-ci](https://github.com/topics/awesome-ci) Makefiles +> [ansible-lint][alint-git-lnk] **•** +> [ansible][ansible-git-lnk] **•** +> [awesome-ci][aci-git-lnk] **•** +> [bandit][bandit-git-lnk] **•** +> [black][black-git-lnk] **•** +> [checkmake][cm-git-lnk] **•** +> [eslint][elint-git-lnk] **•** +> [file-lint][flint-git-lnk] **•** +> [gofmt][gfmt-git-lnk] **•** +> [goimports][gimp-git-lnk] **•** +> [golint][glint-git-lnk] **•** +> [jsonlint][jlint-git-lnk] **•** +> [kubeval][kubeval-git-lnk] **•** +> [linkcheck][linkcheck-git-lnk] **•** +> [mypy][mypy-git-lnk] **•** +> [php-cs-fixer][pcsf-git-lnk] **•** +> [phpcbf][pcbf-git-lnk] **•** +> [phpcs][pcs-git-lnk] **•** +> [phplint][plint-git-lnk] **•** +> [pycodestyle][pycs-git-lnk] **•** +> [pydocstyle][pyds-git-lnk] **•** +> [pylint][pylint-git-lnk] **•** +> [terraform-docs][tfdocs-git-lnk] **•** +> [terragrunt-fmt][tgfmt-git-lnk] **•** +> [terragrunt][tg-git-lnk] **•** +> [yamlfmt][yfmt-git-lnk] **•** +> [yamllint][ylint-git-lnk] +> +> #### Docker images > -> Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for seamless project integration, minimum required best-practice code linting and CI. +> Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite +> linter below for reproducible local or remote CI tests: +> +> | GitHub | DockerHub | Type | Description | +> |--------|-----------|------|-------------| +> | [awesome-ci][aci-git-lnk] | [![aci-hub-img]][aci-hub-lnk] | Basic | Tools for git, file and static source code analysis | +> | [file-lint][flint-git-lnk] | [![flint-hub-img]][flint-hub-lnk] | Basic | Baisc source code analysis | +> | [linkcheck][linkcheck-git-lnk] | [![linkcheck-hub-img]][flint-hub-lnk] | Basic | Search for URLs in files and validate their HTTP status code | +> | [ansible][ansible-git-lnk] | [![ansible-hub-img]][ansible-hub-lnk] | Ansible | Multiple versions and flavours of Ansible | +> | [ansible-lint][alint-git-lnk] | [![alint-hub-img]][alint-hub-lnk] | Ansible | Lint Ansible | +> | [gofmt][gfmt-git-lnk] | [![gfmt-hub-img]][gfmt-hub-lnk] | Go | Format Go source code **[1]** | +> | [goimports][gimp-git-lnk] | [![gimp-hub-img]][gimp-hub-lnk] | Go | Format Go source code **[1]** | +> | [golint][glint-git-lnk] | [![glint-hub-img]][glint-hub-lnk] | Go | Lint Go code | +> | [eslint][elint-git-lnk] | [![elint-hub-img]][elint-hub-lnk] | Javascript | Lint Javascript code | +> | [jsonlint][jlint-git-lnk] | [![jlint-hub-img]][jlint-hub-lnk] | JSON | Lint JSON files **[1]** | +> | [kubeval][kubeval-git-lnk] | [![kubeval-hub-img]][kubeval-hub-lnk] | K8s | Lint Kubernetes files | +> | [checkmake][cm-git-lnk] | [![cm-hub-img]][cm-hub-lnk] | Make | Lint Makefiles | +> | [phpcbf][pcbf-git-lnk] | [![pcbf-hub-img]][pcbf-hub-lnk] | PHP | PHP Code Beautifier and Fixer | +> | [phpcs][pcs-git-lnk] | [![pcs-hub-img]][pcs-hub-lnk] | PHP | PHP Code Sniffer | +> | [phplint][plint-git-lnk] | [![plint-hub-img]][plint-hub-lnk] | PHP | PHP Code Linter **[1]** | +> | [php-cs-fixer][pcsf-git-lnk] | [![pcsf-hub-img]][pcsf-hub-lnk] | PHP | PHP Coding Standards Fixer | +> | [bandit][bandit-git-lnk] | [![bandit-hub-img]][bandit-hub-lnk] | Python | A security linter from PyCQA +> | [black][black-git-lnk] | [![black-hub-img]][black-hub-lnk] | Python | The uncompromising Python code formatter | +> | [mypy][mypy-git-lnk] | [![mypy-hub-img]][mypy-hub-lnk] | Python | Static source code analysis | +> | [pycodestyle][pycs-git-lnk] | [![pycs-hub-img]][pycs-hub-lnk] | Python | Python style guide checker | +> | [pydocstyle][pyds-git-lnk] | [![pyds-hub-img]][pyds-hub-lnk] | Python | Python docstyle checker | +> | [pylint][pylint-git-lnk] | [![pylint-hub-img]][pylint-hub-lnk] | Python | Python source code, bug and quality checker | +> | [terraform-docs][tfdocs-git-lnk] | [![tfdocs-hub-img]][tfdocs-hub-lnk] | Terraform | Terraform doc generator (TF 0.12 ready) **[1]** | +> | [terragrunt][tg-git-lnk] | [![tg-hub-img]][tg-hub-lnk] | Terraform | Terragrunt and Terraform | +> | [terragrunt-fmt][tgfmt-git-lnk] | [![tgfmt-hub-img]][tgfmt-hub-lnk] | Terraform | `terraform fmt` for Terragrunt files **[1]** | +> | [yamlfmt][yfmt-git-lnk] | [![yfmt-hub-img]][yfmt-hub-lnk] | Yaml | Format Yaml files **[1]** | +> | [yamllint][ylint-git-lnk] | [![ylint-hub-img]][ylint-hub-lnk] | Yaml | Lint Yaml files | + +> **[1]** Uses a shell wrapper to add **enhanced functionality** not available by original project. + +[aci-git-lnk]: https://github.com/cytopia/awesome-ci +[aci-hub-img]: https://img.shields.io/docker/pulls/cytopia/awesome-ci.svg +[aci-hub-lnk]: https://hub.docker.com/r/cytopia/awesome-ci + +[flint-git-lnk]: https://github.com/cytopia/docker-file-lint +[flint-hub-img]: https://img.shields.io/docker/pulls/cytopia/file-lint.svg +[flint-hub-lnk]: https://hub.docker.com/r/cytopia/file-lint + +[linkcheck-git-lnk]: https://github.com/cytopia/docker-linkcheck +[linkcheck-hub-img]: https://img.shields.io/docker/pulls/cytopia/linkcheck.svg +[linkcheck-hub-lnk]: https://hub.docker.com/r/cytopia/linkcheck + +[jlint-git-lnk]: https://github.com/cytopia/docker-jsonlint +[jlint-hub-img]: https://img.shields.io/docker/pulls/cytopia/jsonlint.svg +[jlint-hub-lnk]: https://hub.docker.com/r/cytopia/jsonlint + +[ansible-git-lnk]: https://github.com/cytopia/docker-ansible +[ansible-hub-img]: https://img.shields.io/docker/pulls/cytopia/ansible.svg +[ansible-hub-lnk]: https://hub.docker.com/r/cytopia/ansible + +[alint-git-lnk]: https://github.com/cytopia/docker-ansible-lint +[alint-hub-img]: https://img.shields.io/docker/pulls/cytopia/ansible-lint.svg +[alint-hub-lnk]: https://hub.docker.com/r/cytopia/ansible-lint + +[kubeval-git-lnk]: https://github.com/cytopia/docker-kubeval +[kubeval-hub-img]: https://img.shields.io/docker/pulls/cytopia/kubeval.svg +[kubeval-hub-lnk]: https://hub.docker.com/r/cytopia/kubeval + +[gfmt-git-lnk]: https://github.com/cytopia/docker-gofmt +[gfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/gofmt.svg +[gfmt-hub-lnk]: https://hub.docker.com/r/cytopia/gofmt + +[gimp-git-lnk]: https://github.com/cytopia/docker-goimports +[gimp-hub-img]: https://img.shields.io/docker/pulls/cytopia/goimports.svg +[gimp-hub-lnk]: https://hub.docker.com/r/cytopia/goimports + +[glint-git-lnk]: https://github.com/cytopia/docker-golint +[glint-hub-img]: https://img.shields.io/docker/pulls/cytopia/golint.svg +[glint-hub-lnk]: https://hub.docker.com/r/cytopia/golint + +[elint-git-lnk]: https://github.com/cytopia/docker-eslint +[elint-hub-img]: https://img.shields.io/docker/pulls/cytopia/eslint.svg +[elint-hub-lnk]: https://hub.docker.com/r/cytopia/eslint + +[cm-git-lnk]: https://github.com/cytopia/docker-checkmake +[cm-hub-img]: https://img.shields.io/docker/pulls/cytopia/checkmake.svg +[cm-hub-lnk]: https://hub.docker.com/r/cytopia/checkmake + +[pcbf-git-lnk]: https://github.com/cytopia/docker-phpcbf +[pcbf-hub-img]: https://img.shields.io/docker/pulls/cytopia/phpcbf.svg +[pcbf-hub-lnk]: https://hub.docker.com/r/cytopia/phpcbf + +[pcs-git-lnk]: https://github.com/cytopia/docker-phpcs +[pcs-hub-img]: https://img.shields.io/docker/pulls/cytopia/phpcs.svg +[pcs-hub-lnk]: https://hub.docker.com/r/cytopia/phpcs + +[plint-git-lnk]: https://github.com/cytopia/docker-phplint +[plint-hub-img]: https://img.shields.io/docker/pulls/cytopia/phplint.svg +[plint-hub-lnk]: https://hub.docker.com/r/cytopia/phplint + +[pcsf-git-lnk]: https://github.com/cytopia/docker-php-cs-fixer +[pcsf-hub-img]: https://img.shields.io/docker/pulls/cytopia/php-cs-fixer.svg +[pcsf-hub-lnk]: https://hub.docker.com/r/cytopia/php-cs-fixer + +[bandit-git-lnk]: https://github.com/cytopia/docker-bandit +[bandit-hub-img]: https://img.shields.io/docker/pulls/cytopia/bandit.svg +[bandit-hub-lnk]: https://hub.docker.com/r/cytopia/bandit + +[black-git-lnk]: https://github.com/cytopia/docker-black +[black-hub-img]: https://img.shields.io/docker/pulls/cytopia/black.svg +[black-hub-lnk]: https://hub.docker.com/r/cytopia/black + +[mypy-git-lnk]: https://github.com/cytopia/docker-mypy +[mypy-hub-img]: https://img.shields.io/docker/pulls/cytopia/mypy.svg +[mypy-hub-lnk]: https://hub.docker.com/r/cytopia/mypy + +[pycs-git-lnk]: https://github.com/cytopia/docker-pycodestyle +[pycs-hub-img]: https://img.shields.io/docker/pulls/cytopia/pycodestyle.svg +[pycs-hub-lnk]: https://hub.docker.com/r/cytopia/pycodestyle + +[pyds-git-lnk]: https://github.com/cytopia/docker-pydocstyle +[pyds-hub-img]: https://img.shields.io/docker/pulls/cytopia/pydocstyle.svg +[pyds-hub-lnk]: https://hub.docker.com/r/cytopia/pydocstyle + +[pylint-git-lnk]: https://github.com/cytopia/docker-pylint +[pylint-hub-img]: https://img.shields.io/docker/pulls/cytopia/pylint.svg +[pylint-hub-lnk]: https://hub.docker.com/r/cytopia/pylint + +[tfdocs-git-lnk]: https://github.com/cytopia/docker-terraform-docs +[tfdocs-hub-img]: https://img.shields.io/docker/pulls/cytopia/terraform-docs.svg +[tfdocs-hub-lnk]: https://hub.docker.com/r/cytopia/terraform-docs + +[tg-git-lnk]: https://github.com/cytopia/docker-terragrunt +[tg-hub-img]: https://img.shields.io/docker/pulls/cytopia/terragrunt.svg +[tg-hub-lnk]: https://hub.docker.com/r/cytopia/terragrunt + +[tgfmt-git-lnk]: https://github.com/cytopia/docker-terragrunt-fmt +[tgfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/terragrunt-fmt.svg +[tgfmt-hub-lnk]: https://hub.docker.com/r/cytopia/terragrunt-fmt + +[yfmt-git-lnk]: https://github.com/cytopia/docker-yamlfmt +[yfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/yamlfmt.svg +[yfmt-hub-lnk]: https://hub.docker.com/r/cytopia/yamlfmt + +[ylint-git-lnk]: https://github.com/cytopia/docker-yamllint +[ylint-hub-img]: https://img.shields.io/docker/pulls/cytopia/yamllint.svg +[ylint-hub-lnk]: https://hub.docker.com/r/cytopia/yamllint + + +--- + [![Docker image](http://dockeri.co/image/cytopia/awesome-ci?&kill_cache=1)](https://hub.docker.com/r/cytopia/awesome-ci) @@ -218,7 +378,7 @@ make install [![Docker image](http://dockeri.co/image/cytopia/awesome-ci?&kill_cache=1)](https://hub.docker.com/r/cytopia/awesome-ci) Instead of installing awesome-ci and all its required dependencies locally on your computer, -you can also use the bundled Docker image +you can also use the bundled Docker image **[cytopia/awesome-ci](https://hub.docker.com/r/cytopia/awesome-ci/)** which has everything pre-installed and is built nightly by travis-ci.