Skip to content
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

Jump to bottom

chore(pre-commit) - Update pre-commit docs and better support for cfnlintrc #2448

Merged
merged 2 commits into from
Oct 26, 2022
Merged

chore(pre-commit) - Update pre-commit docs and better support for cfnlintrc #2448

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8789872
Update pre-commit docs and better support for cfnlintrc
kddejong Oct 26, 2022
3ae290e
Update readme with more guidance
kddejong Oct 26, 2022
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
Next Next commit
Update pre-commit docs and better support for cfnlintrc
  • Loading branch information
@kddejong
kddejong committed Oct 26, 2022
commit 878987206ef0369e7927f3ed7cca8415d9a4b580
23 changes: 18 additions & 5 deletions .pre-commit-hooks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
- id: cfn-python-lint
name: AWS CloudFormation Linter
entry: cfn-lint
language: python
files: \.(json|yaml|yml)$
- id: cfn-python-lint
name: AWS CloudFormation Linter
description: 'cfn-lint is a tool for finding issues with CloudFormation templates'
entry: cfn-lint
language: python
files: \.(json|yaml|yml)$
- id: cfn-lint # we have removed most identifications to cfn-python-lint
name: AWS CloudFormation Linter
description: 'cfn-lint is a tool for finding issues with CloudFormation templates'
entry: cfn-lint
language: python
files: \.(json|yaml|yml)$
- id: cfn-lint-rc # Provide a configuration to use with .cfnlintrc
name: AWS CloudFormation Linter
description: 'cfn-lint is a tool for finding issues with CloudFormation templates'
entry: cfn-lint
language: python
pass_filenames: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this a lot (the three options)
There is a downside to this last option though, it will always scan all templates, even if you only change one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea, agreed. Trying to give some options so people can pick whats right for them. Besides making .cfnlintrc file work better with pre-commit scanning all templates as cfn-lint specs and rules change could be useful (maybe)?

13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,12 +301,21 @@ If you'd like cfn-lint to be run automatically when making changes to files in y

```yaml
repos:
- repo: https://github.com/aws-cloudformation/cfn-python-lint
- repo: https://github.com/aws-cloudformation/cfn-lint
rev: v0.69.1 # The version of cfn-lint to use
hooks:
- id: cfn-python-lint
- id: cfn-lint
files: path/to/cfn/dir/.*\.(json|yml|yaml)$
```

if you are using a `.cfnlintrc` and specifying the `templates` section we recommend using
```yaml
repos:
- repo: https://github.com/aws-cloudformation/cfn-lint
rev: v0.69.1 # The version of cfn-lint to use
hooks:
- id: cfn-lint-rc
kddejong marked this conversation as resolved.
Show resolved Hide resolved
```

* If you exclude the `files:` line above, every json/yml/yaml file will be checked.
* You can see available cfn-lint versions on the [releases page](https://github.com/aws-cloudformation/cfn-python-lint/releases).