Skip to content

Add usage information #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cytopia merged 2 commits into from
Jun 24, 2019
Merged

Add usage information #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63ee209
Add usage information
cytopia Jun 24, 2019
afc593e
Remove tflint as official image will be used
cytopia Jun 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
> [pylint](https://github.com/cytopia/docker-pylint) **•**
> [terraform-docs](https://github.com/cytopia/docker-terraform-docs) **•**
> [terragrunt](https://github.com/cytopia/docker-terragrunt) **•**
> [tflint](https://github.com/cytopia/docker-tflint) **•**
> [yamllint](https://github.com/cytopia/docker-yamllint)


Expand Down Expand Up @@ -59,8 +58,25 @@ where your Terraform module is located.

## Usage

### Generic
```bash
# Lint a single Makefile
docker run --rm -v $(pwd):/data cytopia/checkmake Makefile

# Lint all available Makefiles
docker run --rm -v $(pwd):/data --entrypoint=find cytopia/checkmake . -name Makefile -exec checkmake {} \;
```

### Configuration

If you want to change the behaviour of `checkmake`, you can add `checkmake.ini` to the root of your
mount location and adjust the linter settings:
```ini
[maxbodylength]
maxBodyLength = 10

[minphony]
disabled = true
```


Expand Down Expand Up @@ -89,7 +105,6 @@ linter below for reproducible local or remote CI tests:
| [pylint](https://github.com/cytopia/docker-pylint) | Python | Python source code, bug and quality checker |
| [terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Terraform | Terraform doc generator (TF 0.12 ready) |
| [terragrunt](https://github.com/cytopia/docker-terragrunt) | Terraform | Terragrunt and Terraform |
| [tflint](https://github.com/cytopia/docker-tflint) | Terraform | Best-practice Terraform linter |


### Makefiles
Expand Down