infra: update the pre-commit hook with linters #678
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| #!/usr/bin/env bash | ||
| if [ -f .pre-commit-config.yaml ]; then | ||
| echo 'pre-commit configuration detected, but `pre-commit install` was never run' 1>&2 | ||
| exit 1 | ||
| fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,8 @@ | ||
| repos: | ||
| - repo: local | ||
| hooks: | ||
| - id: tox_linters | ||
| name: linters | ||
| entry: tox -e linters_check | ||
| language: system | ||
| types: [python] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,6 +41,19 @@ commands = | |
| {[testenv:black]commands} | ||
| {[testenv:flake8]commands} | ||
|
|
||
| # Read only linter env | ||
| [testenv:linters_check] | ||
|
There was a problem hiding this comment. Good call! I missed this as an option. I am also planning on using this test env here in our workflows: https://github.com/aws/amazon-braket-sdk-python/blob/main/.github/workflows/check-format.yml#L29. I shall add this check in for both. |
||
| basepython = python3 | ||
| skip_install = true | ||
| deps = | ||
| {[testenv:isort_check]deps} | ||
| {[testenv:black_check]deps} | ||
| {[testenv:flake8]deps} | ||
| commands = | ||
| {[testenv:isort_check]commands} | ||
| {[testenv:black_check]commands} | ||
| {[testenv:flake8]commands} | ||
|
|
||
| [testenv:flake8] | ||
| basepython = python3 | ||
| skip_install = true | ||
|
|
@@ -60,6 +73,14 @@ deps = | |
| commands = | ||
| isort . {posargs} | ||
|
|
||
| [testenv:isort_check] | ||
| basepython = python3 | ||
| skip_install = true | ||
| deps = | ||
| isort | ||
| commands = | ||
| isort . -c {posargs} | ||
|
|
||
| [testenv:black] | ||
| basepython = python3 | ||
| skip_install = true | ||
|
|
@@ -68,6 +89,14 @@ deps = | |
| commands = | ||
| black ./ {posargs} | ||
|
|
||
| [testenv:black_check] | ||
| basepython = python3 | ||
| skip_install = true | ||
| deps = | ||
| black | ||
| commands = | ||
| black --check . {posargs} | ||
|
|
||
| [testenv:docs] | ||
| basepython = python3 | ||
| deps = | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why remove these? We want the tests to pass before committing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I debated keeping the unit-tests run but I am hesitant around keeping the integ-tests. As these require an AWS account, I am not sure we should expect these to be ran by all contributors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing integ tests makes sense, but I think unit tests are still good to have.