Skip to content

CI: Skip the chmod hook in pre-commit.ci #3415

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
merged 4 commits into from
Aug 27, 2024
Merged

CI: Skip the chmod hook in pre-commit.ci #3415

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d858f77
CI: Move the file permission checking from pre-commit to Style Checks…
seisman Aug 27, 2024
390a749
Update .pre-commit-config.yaml
seisman Aug 27, 2024
4e08f91
Revert "CI: Move the file permission checking from pre-commit to Styl…
seisman Aug 27, 2024
7b918d3
Fix intentation
seisman Aug 27, 2024
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
5 changes: 5 additions & 0 deletions .github/workflows/style_checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ jobs:
make check
pre-commit run --all-files

- name: Ensure files have 644 permission
run: |
git ls-files -z | xargs -0 chmod 644
if [[ $(git ls-files -m) ]]; then git --no-pager diff HEAD; exit 1; fi

- name: Ensure example scripts have at least one code block separator
run: |
git ls-files 'examples/**/*.py' | xargs grep --files-without-match '# %%' > output.txt
Expand Down
2 changes: 0 additions & 2 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ repos:
hooks:
- id: forbid-crlf
- id: remove-crlf
- id: chmod
args: ['644']
Copy link
Member

Choose a reason for hiding this comment

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

You can add a exclude: .pre-commit-config.yaml line to exclude 644 permissions on this file if I'm not mistaken. See https://pre-commit.com/#config-exclude

Copy link
Member

Choose a reason for hiding this comment

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

Oh wait sorry, I misread things. Let me see if there's another way...

Copy link
Member Author

Choose a reason for hiding this comment

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

Since we only care about if files have execute permission, so I thought chmod -x should work. Unfortunately the hook doesn't support it yet https://github.com/Lucas-C/pre-commit-hooks/blob/a30f0d816e5062a67d87c8de753cfe499672b959/pre_commit_hooks/chmod.py#L35-L40.

Copy link
Member

@weiji14 weiji14 Aug 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe we skip the chmod hook on pre-commit.ci using https://pre-commit.ci/#configuration-skip? Since we have the check on the `Style Checks' CI already on GitHub Actions and it doesn't complain there.


# https://pre-commit.ci/#configuration
ci:
Expand Down