Skip to content

CI: Ensure no hyphens in Python file and directory names in the "Style Checks" workflow #3703

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
seisman merged 5 commits into from
Dec 26, 2024
Merged

CI: Ensure no hyphens in Python file and directory names in the "Style Checks" workflow #3703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
492fac6
CI: Ensure no hyphens in Python file and directory names in the "Styl…
seisman Dec 20, 2024
ce5a073
Add '|| true' so that the command doesn't have the non-zero exit code
seisman Dec 20, 2024
9cc00d6
Should check HEAD not main
seisman Dec 20, 2024
5879833
Add files and directories with hyphen to test the workflow
seisman Dec 20, 2024
8deda86
Revert "Add files and directories with hyphen to test the workflow"
seisman Dec 20, 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
1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Fixes #
- [ ] Write detailed docstrings for all functions/methods.
- [ ] If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
- [ ] If adding new functionality, add an example to docstrings or tutorials.
- [ ] Use underscores (not hyphens) in names of Python files and directories.

**Slash Commands**

Expand Down
12 changes: 12 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 @@ -52,3 +52,15 @@ jobs:
rm output.txt
exit $nfiles
fi

- name: Ensure hyphens are not used in names of directories and Python files
run: |
git ls-files '*.py' | grep '-' > output.txt || true
git ls-tree -rd --name-only HEAD | grep '-' >> output.txt || true
nfiles=$(wc --lines output.txt | awk '{print $1}')
if [[ $nfiles > 0 ]]; then
echo "Following directories/files use hyphens in file names:"
cat output.txt
rm output.txt
exit $nfiles
fi
6 changes: 3 additions & 3 deletions doc/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ our tests. This way, the *main* branch is always stable.
integrated separately.
- Bug fixes should be submitted in separate PRs.
* How to write and submit a PR
- Use underscores for all Python (*.py) files as per
[PEP8](https://www.python.org/dev/peps/pep-0008/), not hyphens. Directory
names should also use underscores instead of hyphens.
- Use underscores for all Python (\*.py) files as per
[PEP8](https://www.python.org/dev/peps/pep-0008/), not hyphens. Directory names
should also use underscores instead of hyphens.
- Describe what your PR changes and *why* this is a good thing. Be as
specific as you can. The PR description is how we keep track of the changes
made to the project over time.
Expand Down
Loading