Skip to content

Commit 99c500b

Browse files
cytopiacytopia
committed
Update README
1 parent 1e55219 commit 99c500b

File tree

1 file changed

+88
-90
lines changed

1 file changed

+88
-90
lines changed

‎README.md

Lines changed: 88 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Docker image for `terraform-docs`
22

33
[![Tag](https://img.shields.io/github/tag/cytopia/docker-terraform-docs.svg)](https://github.com/cytopia/docker-terraform-docs/releases)
4-
[![](https://images.microbadger.com/badges/version/cytopia/terraform-docs:latest.svg?kill_cache=1)](https://microbadger.com/images/cytopia/terraform-docs:latest "terraform-docs")
5-
[![](https://images.microbadger.com/badges/image/cytopia/terraform-docs:latest.svg?kill_cache=1)](https://microbadger.com/images/cytopia/terraform-docs:latest "terraform-docs")
6-
[![](https://img.shields.io/docker/pulls/cytopia/terraform-docs.svg)](https://hub.docker.com/r/cytopia/terraform-docs)
74
[![](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")
85
[![License](https://img.shields.io/badge/license-MIT-%233DA639.svg)](https://opensource.org/licenses/MIT)
96

@@ -42,13 +39,10 @@
4239
> [yamlfmt][yfmt-git-lnk] **•**
4340
> [yamllint][ylint-git-lnk]
4441
45-
> #### All [#awesome-ci](https://github.com/topics/awesome-ci) Makefiles
46-
>
47-
> Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for seamless project integration, minimum required best-practice code linting and CI.
42+
View **[Dockerfiles](https://github.com/cytopia/docker-terraform-docs/blob/master/Dockerfiles/)** on GitHub.
4843

49-
View **[Dockerfile](https://github.com/cytopia/docker-terraform-docs/blob/master/Dockerfile)** on GitHub.
5044

51-
[![Docker hub](http://dockeri.co/image/cytopia/terraform-docs?kill_cache=1)](https://hub.docker.com/r/cytopia/terraform-docs)
45+
**Available Architectures:** `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6`
5246

5347
Tiny Alpine-based multistage-build dockerized version of [terraform-docs](https://github.com/terraform-docs/terraform-docs)<sup>[1]</sup>,
5448
which additionally implements `terraform-docs-replace` allowing you to automatically and safely
@@ -59,85 +53,88 @@ The image is built nightly against multiple stable versions and pushed to Docker
5953
* <sub>[1] Official project: https://github.com/terraform-docs/terraform-docs</sub>
6054
* <sub>[2] Based on an awk script by [cloudposse/build-harness](https://github.com/cloudposse/build-harness/blob/master/bin/terraform-docs.awk)</sub>
6155

56+
## :whale: Available Docker image versions
57+
58+
[![](https://img.shields.io/docker/pulls/cytopia/terraform-docs.svg)](https://hub.docker.com/r/cytopia/terraform-docs)
59+
[![Docker](https://badgen.net/badge/icon/:latest?icon=docker&label=cytopia/terraform-docs)](https://hub.docker.com/r/cytopia/terraform-docs)
6260

63-
## Available Docker image versions
64-
65-
### Rolling releases
66-
The following Docker image tags are rolling releases and built and updated nightly. This means any
67-
scripts from this repository which enhance the original `terraform-docs` are always available at
68-
their latest state (from this repository's master branch) and *might* cause backwards
69-
incompatibilities with how you use it (although it's very unlikely that backwards incompatible
70-
changes will be introduced).
71-
72-
| Docker tag | Build from [docker-terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Build from [terraform-docs](https://github.com/terraform-docs/terraform-docs) |
73-
|-----------------|----------------------------------|---------------------------|
74-
| `latest` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Branch: master](https://github.com/terraform-docs/terraform-docs) |
75-
| `0.16.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.16.0](https://github.com/terraform-docs/terraform-docs/tree/v0.16.0) |
76-
| `0.15.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.15.0](https://github.com/terraform-docs/terraform-docs/tree/v0.15.0) |
77-
| `0.14.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.14.1](https://github.com/terraform-docs/terraform-docs/tree/v0.14.1) |
78-
| `0.14.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.14.0](https://github.com/terraform-docs/terraform-docs/tree/v0.14.0) |
79-
| `0.13.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.13.0](https://github.com/terraform-docs/terraform-docs/tree/v0.13.0) |
80-
| `0.12.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.12.1](https://github.com/terraform-docs/terraform-docs/tree/v0.12.1) |
81-
| `0.12.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.12.0](https://github.com/terraform-docs/terraform-docs/tree/v0.12.0) |
82-
| `0.11.2` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.11.2](https://github.com/terraform-docs/terraform-docs/tree/v0.11.2) |
83-
| `0.11.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.11.1](https://github.com/terraform-docs/terraform-docs/tree/v0.11.1) |
84-
| `0.11.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.11.0](https://github.com/terraform-docs/terraform-docs/tree/v0.11.0) |
85-
| `0.10.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.10.1](https://github.com/terraform-docs/terraform-docs/tree/v0.10.1) |
86-
| `0.10.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.10.0](https://github.com/terraform-docs/terraform-docs/tree/v0.10.0) |
87-
| `0.9.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.9.1](https://github.com/terraform-docs/terraform-docs/tree/v0.9.1) |
88-
| `0.9.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.9.0](https://github.com/terraform-docs/terraform-docs/tree/v0.9.0) |
89-
| `0.8.2` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.2](https://github.com/terraform-docs/terraform-docs/tree/v0.8.2) |
90-
| `0.8.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.1](https://github.com/terraform-docs/terraform-docs/tree/v0.8.1) |
91-
| `0.8.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.0](https://github.com/terraform-docs/terraform-docs/tree/v0.8.0) |
92-
| `0.7.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.7.0](https://github.com/terraform-docs/terraform-docs/tree/v0.7.0) |
93-
| `0.6.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.6.0](https://github.com/terraform-docs/terraform-docs/tree/v0.6.0) |
94-
| `0.5.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.5.0](https://github.com/terraform-docs/terraform-docs/tree/v0.5.0) |
95-
| `0.4.5` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.4.5](https://github.com/terraform-docs/terraform-docs/tree/v0.4.5) |
96-
| `0.4.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.4.0](https://github.com/terraform-docs/terraform-docs/tree/v0.4.0) |
97-
| `0.3.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.3.0](https://github.com/terraform-docs/terraform-docs/tree/v0.3.0) |
98-
| `0.2.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.2.0](https://github.com/terraform-docs/terraform-docs/tree/v0.2.0) |
99-
| `0.1.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.1.1](https://github.com/terraform-docs/terraform-docs/tree/v0.1.1) |
100-
| `0.1.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.1.0](https://github.com/terraform-docs/terraform-docs/tree/v0.1.0) |
101-
102-
### Point in time releases
103-
If you want to ensure to have reproducible Terraform doc generation you should use a git tag from
104-
this repository. Tags are incremented for each new version, but never updated itself. This means
105-
you will have to take care yourself and update your CI tools every time a new tag is being released.
106-
107-
| Docker tag | Build from [docker-terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Build from [terraform-docs](https://github.com/terraform-docs/terraform-docs) |
108-
|-----------------------|----------------------------------|---------------------------|
109-
| `latest-<tag>` | Tag: `<tag>` | [Branch: master](https://github.com/terraform-docs/terraform-docs) |
110-
| `0.16.0-<tag>` | Tag: `<tag>` | [Tag: v0.16.0](https://github.com/terraform-docs/terraform-docs/tree/v0.16.0) |
111-
| `0.15.0-<tag>` | Tag: `<tag>` | [Tag: v0.15.0](https://github.com/terraform-docs/terraform-docs/tree/v0.15.0) |
112-
| `0.14.1-<tag>` | Tag: `<tag>` | [Tag: v0.14.1](https://github.com/terraform-docs/terraform-docs/tree/v0.14.1) |
113-
| `0.14.0-<tag>` | Tag: `<tag>` | [Tag: v0.14.0](https://github.com/terraform-docs/terraform-docs/tree/v0.14.0) |
114-
| `0.13.0-<tag>` | Tag: `<tag>` | [Tag: v0.13.0](https://github.com/terraform-docs/terraform-docs/tree/v0.13.0) |
115-
| `0.12.1-<tag>` | Tag: `<tag>` | [Tag: v0.12.1](https://github.com/terraform-docs/terraform-docs/tree/v0.12.1) |
116-
| `0.12.0-<tag>` | Tag: `<tag>` | [Tag: v0.12.0](https://github.com/terraform-docs/terraform-docs/tree/v0.12.0) |
117-
| `0.11.2-<tag>` | Tag: `<tag>` | [Tag: v0.11.2](https://github.com/terraform-docs/terraform-docs/tree/v0.11.2) |
118-
| `0.11.1-<tag>` | Tag: `<tag>` | [Tag: v0.11.1](https://github.com/terraform-docs/terraform-docs/tree/v0.11.1) |
119-
| `0.11.0-<tag>` | Tag: `<tag>` | [Tag: v0.11.0](https://github.com/terraform-docs/terraform-docs/tree/v0.11.0) |
120-
| `0.10.1-<tag>` | Tag: `<tag>` | [Tag: v0.10.1](https://github.com/terraform-docs/terraform-docs/tree/v0.10.1) |
121-
| `0.10.0-<tag>` | Tag: `<tag>` | [Tag: v0.10.0](https://github.com/terraform-docs/terraform-docs/tree/v0.10.0) |
122-
| `0.9.1-<tag>` | Tag: `<tag>` | [Tag: v0.9.1](https://github.com/terraform-docs/terraform-docs/tree/v0.9.1) |
123-
| `0.9.0-<tag>` | Tag: `<tag>` | [Tag: v0.9.0](https://github.com/terraform-docs/terraform-docs/tree/v0.9.0) |
124-
| `0.8.2-<tag>` | Tag: `<tag>` | [Tag: v0.8.2](https://github.com/terraform-docs/terraform-docs/tree/v0.8.2) |
125-
| `0.8.1-<tag>` | Tag: `<tag>` | [Tag: v0.8.1](https://github.com/terraform-docs/terraform-docs/tree/v0.8.1) |
126-
| `0.8.0-<tag>` | Tag: `<tag>` | [Tag: v0.8.0](https://github.com/terraform-docs/terraform-docs/tree/v0.8.0) |
127-
| `0.7.0-<tag>` | Tag: `<tag>` | [Tag: v0.7.0](https://github.com/terraform-docs/terraform-docs/tree/v0.7.0) |
128-
| `0.6.0-<tag>` | Tag: `<tag>` | [Tag: v0.6.0](https://github.com/terraform-docs/terraform-docs/tree/v0.6.0) |
129-
| `0.5.0-<tag>` | Tag: `<tag>` | [Tag: v0.5.0](https://github.com/terraform-docs/terraform-docs/tree/v0.5.0) |
130-
| `0.4.5-<tag>` | Tag: `<tag>` | [Tag: v0.4.5](https://github.com/terraform-docs/terraform-docs/tree/v0.4.5) |
131-
| `0.4.0-<tag>` | Tag: `<tag>` | [Tag: v0.4.0](https://github.com/terraform-docs/terraform-docs/tree/v0.4.0) |
132-
| `0.3.0-<tag>` | Tag: `<tag>` | [Tag: v0.3.0](https://github.com/terraform-docs/terraform-docs/tree/v0.3.0) |
133-
| `0.2.0-<tag>` | Tag: `<tag>` | [Tag: v0.2.0](https://github.com/terraform-docs/terraform-docs/tree/v0.2.0) |
134-
| `0.1.1-<tag>` | Tag: `<tag>` | [Tag: v0.1.1](https://github.com/terraform-docs/terraform-docs/tree/v0.1.1) |
135-
| `0.1.0-<tag>` | Tag: `<tag>` | [Tag: v0.1.0](https://github.com/terraform-docs/terraform-docs/tree/v0.1.0) |
136-
137-
Where `<tag>` refers to the chosen git tag from this repository.
138-
139-
140-
## Environment variables
61+
#### Rolling releaess
62+
63+
The following Docker image tags are rolling releases and are built and updated every night.
64+
65+
[![nightly](https://github.com/cytopia/docker-terraform-docs/workflows/nightly/badge.svg)](https://github.com/cytopia/docker-terraform-docs/actions?query=workflow%3Anightly)
66+
67+
| Docker Tag | Git Ref | Terraform Docs | Available Architectures |
68+
|----------------------|-----------|--------------|----------------------------------------------|
69+
| `latest` | master | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
70+
| `0.16.0` | master | **`0.16.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
71+
| `0.15.0` | master | **`0.15.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
72+
| `0.14.1` | master | **`0.14.1`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
73+
| `0.14.0` | master | **`0.14.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
74+
| `0.13.0` | master | **`0.13.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
75+
| `0.12.1` | master | **`0.12.1`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
76+
| `0.12.0` | master | **`0.12.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
77+
| `0.11.2` | master | **`0.11.2`** | `amd64` |
78+
| `0.11.1` | master | **`0.11.1`** | `amd64` |
79+
| `0.11.0` | master | **`0.11.0`** | `amd64` |
80+
| `0.10.1` | master | **`0.10.1`** | `amd64` |
81+
| `0.10.0` | master | **`0.10.0`** | `amd64` |
82+
| `0.9.1` | master | **`0.9.1`** | `amd64` |
83+
| `0.9.0` | master | **`0.9.0`** | `amd64` |
84+
| `0.8.2` | master | **`0.8.2`** | `amd64` |
85+
| `0.8.1` | master | **`0.8.1`** | `amd64` |
86+
| `0.8.0` | master | **`0.8.0`** | `amd64` |
87+
| `0.7.0` | master | **`0.7.0`** | `amd64` |
88+
| `0.6.0` | master | **`0.6.0`** | `amd64` |
89+
| `0.5.0` | master | **`0.5.0`** | `amd64` |
90+
| `0.4.5` | master | **`0.4.5`** | `amd64` |
91+
| `0.4.0` | master | **`0.4.0`** | `amd64` |
92+
| `0.3.0` | master | **`0.3.0`** | `amd64` |
93+
| `0.2.0` | master | **`0.2.0`** | `amd64` |
94+
| `0.1.1` | master | **`0.1.1`** | `amd64` |
95+
| `0.1.0` | master | **`0.1.0`** | `amd64` |
96+
97+
98+
#### Point in time releases
99+
100+
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.
101+
102+
[![build](https://github.com/cytopia/docker-terraform-docs/workflows/build/badge.svg)](https://github.com/cytopia/docker-terraform-docs/actions?query=workflow%3Abuild)
103+
104+
105+
| Docker Tag | Git Ref | Terraform Docs | Available Architectures |
106+
|----------------------|-----------|--------------|----------------------------------------------|
107+
| `latest-0.32` | tag: 0.32 | latest | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
108+
| `0.16.0-0.32` | tag: 0.32 | **`0.16.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
109+
| `0.15.0-0.32` | tag: 0.32 | **`0.15.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
110+
| `0.14.1-0.32` | tag: 0.32 | **`0.14.1`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
111+
| `0.14.0-0.32` | tag: 0.32 | **`0.14.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
112+
| `0.13.0-0.32` | tag: 0.32 | **`0.13.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
113+
| `0.12.1-0.32` | tag: 0.32 | **`0.12.1`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
114+
| `0.12.0-0.32` | tag: 0.32 | **`0.12.0`** | `amd64`, `i386`, `arm64`, `arm/v7`, `arm/v6` |
115+
| `0.11.2-0.32` | tag: 0.32 | **`0.11.2`** | `amd64` |
116+
| `0.11.1-0.32` | tag: 0.32 | **`0.11.1`** | `amd64` |
117+
| `0.11.0-0.32` | tag: 0.32 | **`0.11.0`** | `amd64` |
118+
| `0.10.1-0.32` | tag: 0.32 | **`0.10.1`** | `amd64` |
119+
| `0.10.0-0.32` | tag: 0.32 | **`0.10.0`** | `amd64` |
120+
| `0.9.1-0.32` | tag: 0.32 | **`0.9.1`** | `amd64` |
121+
| `0.9.0-0.32` | tag: 0.32 | **`0.9.0`** | `amd64` |
122+
| `0.8.2-0.32` | tag: 0.32 | **`0.8.2`** | `amd64` |
123+
| `0.8.1-0.32` | tag: 0.32 | **`0.8.1`** | `amd64` |
124+
| `0.8.0-0.32` | tag: 0.32 | **`0.8.0`** | `amd64` |
125+
| `0.7.0-0.32` | tag: 0.32 | **`0.7.0`** | `amd64` |
126+
| `0.6.0-0.32` | tag: 0.32 | **`0.6.0`** | `amd64` |
127+
| `0.5.0-0.32` | tag: 0.32 | **`0.5.0`** | `amd64` |
128+
| `0.4.5-0.32` | tag: 0.32 | **`0.4.5`** | `amd64` |
129+
| `0.4.0-0.32` | tag: 0.32 | **`0.4.0`** | `amd64` |
130+
| `0.3.0-0.32` | tag: 0.32 | **`0.3.0`** | `amd64` |
131+
| `0.2.0-0.32` | tag: 0.32 | **`0.2.0`** | `amd64` |
132+
| `0.1.1-0.32` | tag: 0.32 | **`0.1.1`** | `amd64` |
133+
| `0.1.0-0.32` | tag: 0.32 | **`0.1.0`** | `amd64` |
134+
135+
136+
137+
## :capital_abcd: Environment variables
141138

142139
The following Docker environment variables are available. These will only need to be used when
143140
using `terraform-docs-replace` or `terraform-docs-replace-012`.
@@ -148,13 +145,13 @@ using `terraform-docs-replace` or `terraform-docs-replace-012`.
148145
| DELIM_CLOSE | `<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->` | No | The ending delimiter in the file in where you want to replace the `terraform-docs` output. |
149146

150147

151-
## Docker mounts
148+
## :open_file_folder: Docker mounts
152149

153150
The working directory inside the Docker container is **`/data/`** and should be mounted locally to
154151
where your Terraform module is located.
155152

156153

157-
## Usage
154+
## :computer: Usage
158155

159156
### Generic
160157
```bash
@@ -374,7 +371,7 @@ script:
374371
```
375372
376373
377-
## Example projects
374+
## :information_source: Example projects
378375
379376
Find below some example projects how this Docker image is used in CI to verify if the README.md has
380377
been updated with the latest changes generated from `terraform-docs`:
@@ -537,7 +534,8 @@ Visit **[cytopia/makefiles](https://github.com/cytopia/makefiles)** for dependen
537534
The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.
538535
539536
540-
## License
537+
## :page_facing_up: License
538+
541539
542540
**[MIT License](LICENSE)**
543541

0 commit comments

Comments
 (0)