Skip to content

Commit 17720c6

Browse files
cytopiacytopia
authored
Merge pull request #21 from cytopia/docs
Update related projects
2 parents fd80ad4 + aa4e054 commit 17720c6

File tree

1 file changed

+136
-45
lines changed

1 file changed

+136
-45
lines changed

‎README.md

Lines changed: 136 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,34 @@
44
[![Tag](https://img.shields.io/github/tag/cytopia/docker-terraform-docs.svg)](https://github.com/cytopia/docker-terraform-docs/releases)
55
[![](https://images.microbadger.com/badges/version/cytopia/terraform-docs:latest.svg?kill_cache=1)](https://microbadger.com/images/cytopia/terraform-docs:latest "terraform-docs")
66
[![](https://images.microbadger.com/badges/image/cytopia/terraform-docs:latest.svg?kill_cache=1)](https://microbadger.com/images/cytopia/terraform-docs:latest "terraform-docs")
7+
[![](https://img.shields.io/docker/pulls/cytopia/terraform-docs.svg)](https://hub.docker.com/r/cytopia/terraform-docs)
78
[![](https://img.shields.io/badge/github-cytopia%2Fdocker--terraform--docs-red.svg)](https://github.com/cytopia/docker-terraform-docs "github.com/cytopia/docker-terraform-docs")
89
[![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT)
910

1011
> #### All [#awesome-ci](https://github.com/topics/awesome-ci) Docker images
1112
>
12-
> [ansible](https://github.com/cytopia/docker-ansible) **•**
13-
> [ansible-lint](https://github.com/cytopia/docker-ansible-lint) **•**
14-
> [awesome-ci](https://github.com/cytopia/awesome-ci) **•**
15-
> [black](https://github.com/cytopia/docker-black) **•**
16-
> [checkmake](https://github.com/cytopia/docker-checkmake) **•**
17-
> [eslint](https://github.com/cytopia/docker-eslint) **•**
18-
> [file-lint](https://github.com/cytopia/docker-file-lint) **•**
19-
> [gofmt](https://github.com/cytopia/docker-gofmt) **•**
20-
> [goimports](https://github.com/cytopia/docker-goimports) **•**
21-
> [golint](https://github.com/cytopia/docker-golint) **•**
22-
> [jsonlint](https://github.com/cytopia/docker-jsonlint) **•**
23-
> [phpcbf](https://github.com/cytopia/docker-phpcbf) **•**
24-
> [phpcs](https://github.com/cytopia/docker-phpcs) **•**
25-
> [php-cs-fixer](https://github.com/cytopia/docker-php-cs-fixer) **•**
26-
> [pycodestyle](https://github.com/cytopia/docker-pycodestyle) **•**
27-
> [pylint](https://github.com/cytopia/docker-pylint) **•**
28-
> [terraform-docs](https://github.com/cytopia/docker-terraform-docs) **•**
29-
> [terragrunt](https://github.com/cytopia/docker-terragrunt) **•**
30-
> [terragrunt-fmt](https://github.com/cytopia/docker-terragrunt-fmt) **•**
31-
> [yamllint](https://github.com/cytopia/docker-yamllint)
32-
13+
> [ansible][ansible-git-lnk] **•**
14+
> [ansible-lint][alint-git-lnk] **•**
15+
> [awesome-ci][aci-git-lnk] **•**
16+
> [black][black-git-lnk] **•**
17+
> [checkmake][cm-git-lnk] **•**
18+
> [eslint][elint-git-lnk] **•**
19+
> [file-lint][flint-git-lnk] **•**
20+
> [gofmt][gfmt-git-lnk] **•**
21+
> [goimports][gimp-git-lnk] **•**
22+
> [golint][glint-git-lnk] **•**
23+
> [jsonlint][jlint-git-lnk] **•**
24+
> [phpcbf][pcbf-git-lnk] **•**
25+
> [phpcs][pcs-git-lnk] **•**
26+
> [phplint][plint-git-lnk] **•**
27+
> [php-cs-fixer][pcsf-git-lnk] **•**
28+
> [pycodestyle][pycs-git-lnk] **•**
29+
> [pylint][pylint-git-lnk] **•**
30+
> [terraform-docs][tfdocs-git-lnk] **•**
31+
> [terragrunt][tg-git-lnk] **•**
32+
> [terragrunt-fmt][tgfmt-git-lnk] **•**
33+
> [yamlfmt][yfmt-git-lnk] **•**
34+
> [yamllint][ylint-git-lnk]
3335
3436
> #### All [#awesome-ci](https://github.com/topics/awesome-ci) Makefiles
3537
>
@@ -103,7 +105,7 @@ using `terraform-docs-replace` or `terraform-docs-replace-012`.
103105

104106
## Docker mounts
105107

106-
The working directory inside the Docker container is `/data/` and should be mounted locally to
108+
The working directory inside the Docker container is **`/data/`** and should be mounted locally to
107109
where your Terraform module is located.
108110

109111

@@ -321,7 +323,6 @@ sudo: required
321323
language: minimal
322324
services:
323325
- docker
324-
install: true
325326
script:
326327
- make gen
327328
- git diff --quiet || { echo "Build Changes"; git diff; git status; false; }
@@ -344,31 +345,121 @@ been updated with the latest changes generated from `terraform-docs`:
344345
Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite
345346
linter below for reproducible local or remote CI tests:
346347
347-
| Docker image | Type | Description |
348-
|--------------|------|-------------|
349-
| [awesome-ci](https://github.com/cytopia/awesome-ci) | Basic | Tools for git, file and static source code analysis |
350-
| [file-lint](https://github.com/cytopia/docker-file-lint) | Basic | Baisc source code analysis |
351-
| [jsonlint](https://github.com/cytopia/docker-jsonlint) | Basic | Lint JSON files **<sup>[1]</sup>** |
352-
| [yamllint](https://github.com/cytopia/docker-yamllint) | Basic | Lint Yaml files |
353-
| [ansible](https://github.com/cytopia/docker-ansible) | Ansible | Multiple versoins of Ansible |
354-
| [ansible-lint](https://github.com/cytopia/docker-ansible-lint) | Ansible | Lint Ansible |
355-
| [gofmt](https://github.com/cytopia/docker-gofmt) | Go | Format Go source code **<sup>[1]</sup>** |
356-
| [goimports](https://github.com/cytopia/docker-goimports) | Go | Format Go source code **<sup>[1]</sup>** |
357-
| [golint](https://github.com/cytopia/docker-golint) | Go | Lint Go code |
358-
| [eslint](https://github.com/cytopia/docker-eslint) | Javascript | Lint Javascript code |
359-
| [checkmake](https://github.com/cytopia/docker-checkmake) | Make | Lint Makefiles |
360-
| [phpcbf](https://github.com/cytopia/docker-phpcbf) | PHP | PHP Code Beautifier and Fixer |
361-
| [phpcs](https://github.com/cytopia/docker-phpcs) | PHP | PHP Code Sniffer |
362-
| [php-cs-fixer](https://github.com/cytopia/docker-php-cs-fixer) | PHP | PHP Coding Standards Fixer |
363-
| [black](https://github.com/cytopia/docker-black) | Python | The uncompromising Python code formatter |
364-
| [pycodestyle](https://github.com/cytopia/docker-pycodestyle) | Python | Python style guide checker |
365-
| [pylint](https://github.com/cytopia/docker-pylint) | Python | Python source code, bug and quality checker |
366-
| [terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Terraform | Terraform doc generator (TF 0.12 ready) **<sup>[1]</sup>** |
367-
| [terragrunt](https://github.com/cytopia/docker-terragrunt) | Terraform | Terragrunt and Terraform |
368-
| [terragrunt-fmt](https://github.com/cytopia/docker-terragrunt-fmt) | Terraform | `terraform fmt` for Terragrunt files **<sup>[1]</sup>** |
348+
| GitHub | DockerHub | Type | Description |
349+
|--------|-----------|------|-------------|
350+
| [awesome-ci][aci-git-lnk] | [![aci-hub-img]][aci-hub-lnk] | Basic | Tools for git, file and static source code analysis |
351+
| [file-lint][flint-git-lnk] | [![flint-hub-img]][flint-hub-lnk] | Basic | Baisc source code analysis |
352+
| [ansible][ansible-git-lnk] | [![ansible-hub-img]][ansible-hub-lnk] | Ansible | Multiple versions and flavours of Ansible |
353+
| [ansible-lint][alint-git-lnk] | [![alint-hub-img]][alint-hub-lnk] | Ansible | Lint Ansible |
354+
| [gofmt][gfmt-git-lnk] | [![gfmt-hub-img]][gfmt-hub-lnk] | Go | Format Go source code **<sup>[1]</sup>** |
355+
| [goimports][gimp-git-lnk] | [![gimp-hub-img]][gimp-hub-lnk] | Go | Format Go source code **<sup>[1]</sup>** |
356+
| [golint][glint-git-lnk] | [![glint-hub-img]][glint-hub-lnk] | Go | Lint Go code |
357+
| [eslint][elint-git-lnk] | [![elint-hub-img]][elint-hub-lnk] | Javascript | Lint Javascript code |
358+
| [jsonlint][jlint-git-lnk] | [![jlint-hub-img]][jlint-hub-lnk] | JSON | Lint JSON files **<sup>[1]</sup>** |
359+
| [checkmake][cm-git-lnk] | [![cm-hub-img]][cm-hub-lnk] | Make | Lint Makefiles |
360+
| [phpcbf][pcbf-git-lnk] | [![pcbf-hub-img]][pcbf-hub-lnk] | PHP | PHP Code Beautifier and Fixer |
361+
| [phpcs][pcs-git-lnk] | [![pcs-hub-img]][pcs-hub-lnk] | PHP | PHP Code Sniffer |
362+
| [phplint][plint-git-lnk] | [![plint-hub-img]][plint-hub-lnk] | PHP | PHP Code Linter **<sup>[1]</sup>** |
363+
| [php-cs-fixer][pcsf-git-lnk] | [![pcsf-hub-img]][pcsf-hub-lnk] | PHP | PHP Coding Standards Fixer |
364+
| [black][black-git-lnk] | [![black-hub-img]][black-hub-lnk] | Python | The uncompromising Python code formatter |
365+
| [pycodestyle][pycs-git-lnk] | [![pycs-hub-img]][pycs-hub-lnk] | Python | Python style guide checker |
366+
| [pylint][pylint-git-lnk] | [![pylint-hub-img]][pylint-hub-lnk] | Python | Python source code, bug and quality checker |
367+
| [terraform-docs][tfdocs-git-lnk] | [![tfdocs-hub-img]][tfdocs-hub-lnk] | Terraform | Terraform doc generator (TF 0.12 ready) **<sup>[1]</sup>** |
368+
| [terragrunt][tg-git-lnk] | [![tg-hub-img]][tg-hub-lnk] | Terraform | Terragrunt and Terraform |
369+
| [terragrunt-fmt][tgfmt-git-lnk] | [![tgfmt-hub-img]][tgfmt-hub-lnk] | Terraform | `terraform fmt` for Terragrunt files **<sup>[1]</sup>** |
370+
| [yamlfmt][yfmt-git-lnk] | [![yfmt-hub-img]][yfmt-hub-lnk] | Yaml | Format Yaml files **<sup>[1]</sup>** |
371+
| [yamllint][ylint-git-lnk] | [![ylint-hub-img]][ylint-hub-lnk] | Yaml | Lint Yaml files |
369372
370373
> **<sup>[1]</sup>** Uses a shell wrapper to add **enhanced functionality** not available by original project.
371374
375+
[aci-git-lnk]: https://github.com/cytopia/awesome-ci
376+
[aci-hub-img]: https://img.shields.io/docker/pulls/cytopia/awesome-ci.svg
377+
[aci-hub-lnk]: https://hub.docker.com/r/cytopia/awesome-ci
378+
379+
[flint-git-lnk]: https://github.com/cytopia/docker-file-lint
380+
[flint-hub-img]: https://img.shields.io/docker/pulls/cytopia/file-lint.svg
381+
[flint-hub-lnk]: https://hub.docker.com/r/cytopia/file-lint
382+
383+
[jlint-git-lnk]: https://github.com/cytopia/docker-jsonlint
384+
[jlint-hub-img]: https://img.shields.io/docker/pulls/cytopia/jsonlint.svg
385+
[jlint-hub-lnk]: https://hub.docker.com/r/cytopia/jsonlint
386+
387+
[ansible-git-lnk]: https://github.com/cytopia/docker-ansible
388+
[ansible-hub-img]: https://img.shields.io/docker/pulls/cytopia/ansible.svg
389+
[ansible-hub-lnk]: https://hub.docker.com/r/cytopia/ansible
390+
391+
[alint-git-lnk]: https://github.com/cytopia/docker-ansible-lint
392+
[alint-hub-img]: https://img.shields.io/docker/pulls/cytopia/ansible-lint.svg
393+
[alint-hub-lnk]: https://hub.docker.com/r/cytopia/ansible-lint
394+
395+
[gfmt-git-lnk]: https://github.com/cytopia/docker-gofmt
396+
[gfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/gofmt.svg
397+
[gfmt-hub-lnk]: https://hub.docker.com/r/cytopia/gofmt
398+
399+
[gimp-git-lnk]: https://github.com/cytopia/docker-goimports
400+
[gimp-hub-img]: https://img.shields.io/docker/pulls/cytopia/goimports.svg
401+
[gimp-hub-lnk]: https://hub.docker.com/r/cytopia/goimports
402+
403+
[glint-git-lnk]: https://github.com/cytopia/docker-golint
404+
[glint-hub-img]: https://img.shields.io/docker/pulls/cytopia/golint.svg
405+
[glint-hub-lnk]: https://hub.docker.com/r/cytopia/golint
406+
407+
[elint-git-lnk]: https://github.com/cytopia/docker-eslint
408+
[elint-hub-img]: https://img.shields.io/docker/pulls/cytopia/eslint.svg
409+
[elint-hub-lnk]: https://hub.docker.com/r/cytopia/eslint
410+
411+
[cm-git-lnk]: https://github.com/cytopia/docker-checkmake
412+
[cm-hub-img]: https://img.shields.io/docker/pulls/cytopia/checkmake.svg
413+
[cm-hub-lnk]: https://hub.docker.com/r/cytopia/checkmake
414+
415+
[pcbf-git-lnk]: https://github.com/cytopia/docker-phpcbf
416+
[pcbf-hub-img]: https://img.shields.io/docker/pulls/cytopia/phpcbf.svg
417+
[pcbf-hub-lnk]: https://hub.docker.com/r/cytopia/phpcbf
418+
419+
[pcs-git-lnk]: https://github.com/cytopia/docker-phpcs
420+
[pcs-hub-img]: https://img.shields.io/docker/pulls/cytopia/phpcs.svg
421+
[pcs-hub-lnk]: https://hub.docker.com/r/cytopia/phpcs
422+
423+
[plint-git-lnk]: https://github.com/cytopia/docker-phplint
424+
[plint-hub-img]: https://img.shields.io/docker/pulls/cytopia/phplint.svg
425+
[plint-hub-lnk]: https://hub.docker.com/r/cytopia/phplint
426+
427+
[pcsf-git-lnk]: https://github.com/cytopia/docker-php-cs-fixer
428+
[pcsf-hub-img]: https://img.shields.io/docker/pulls/cytopia/php-cs-fixer.svg
429+
[pcsf-hub-lnk]: https://hub.docker.com/r/cytopia/php-cs-fixer
430+
431+
[black-git-lnk]: https://github.com/cytopia/docker-black
432+
[black-hub-img]: https://img.shields.io/docker/pulls/cytopia/black.svg
433+
[black-hub-lnk]: https://hub.docker.com/r/cytopia/black
434+
435+
[pycs-git-lnk]: https://github.com/cytopia/docker-pycodestyle
436+
[pycs-hub-img]: https://img.shields.io/docker/pulls/cytopia/pycodestyle.svg
437+
[pycs-hub-lnk]: https://hub.docker.com/r/cytopia/pycodestyle
438+
439+
[pylint-git-lnk]: https://github.com/cytopia/docker-pylint
440+
[pylint-hub-img]: https://img.shields.io/docker/pulls/cytopia/pylint.svg
441+
[pylint-hub-lnk]: https://hub.docker.com/r/cytopia/pylint
442+
443+
[tfdocs-git-lnk]: https://github.com/cytopia/docker-terraform-docs
444+
[tfdocs-hub-img]: https://img.shields.io/docker/pulls/cytopia/terraform-docs.svg
445+
[tfdocs-hub-lnk]: https://hub.docker.com/r/cytopia/terraform-docs
446+
447+
[tg-git-lnk]: https://github.com/cytopia/docker-terragrunt
448+
[tg-hub-img]: https://img.shields.io/docker/pulls/cytopia/terragrunt.svg
449+
[tg-hub-lnk]: https://hub.docker.com/r/cytopia/terragrunt
450+
451+
[tgfmt-git-lnk]: https://github.com/cytopia/docker-terragrunt-fmt
452+
[tgfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/terragrunt-fmt.svg
453+
[tgfmt-hub-lnk]: https://hub.docker.com/r/cytopia/terragrunt-fmt
454+
455+
[yfmt-git-lnk]: https://github.com/cytopia/docker-yamlfmt
456+
[yfmt-hub-img]: https://img.shields.io/docker/pulls/cytopia/yamlfmt.svg
457+
[yfmt-hub-lnk]: https://hub.docker.com/r/cytopia/yamlfmt
458+
459+
[ylint-git-lnk]: https://github.com/cytopia/docker-yamllint
460+
[ylint-hub-img]: https://img.shields.io/docker/pulls/cytopia/yamllint.svg
461+
[ylint-hub-lnk]: https://hub.docker.com/r/cytopia/yamllint
462+
372463
373464
### Makefiles
374465

0 commit comments

Comments
 (0)