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

CI: configure pre-commit with ruff and other simple checks, run pre-commit in CI #159

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

CI: configure pre-commit with ruff and other simple checks, run pre-commit in CI #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b39ea8
Add ruff and other simple checks to pre-commit config
eguiraud Jun 13, 2023
c326c94
Add jupytext config to pyproject.toml
eguiraud Jun 13, 2023
f773033
Run pre-commit in GitHub CI
eguiraud Jun 13, 2023
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: 3 additions & 2 deletions .github/workflows/CI.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ jobs:
pip install -r docs/requirements.txt
sphinx-build docs docs/_build

linter:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: jpetrucciani/ruff-check@main
- uses: actions/setup-python@v3
- uses: pre-commit/[email protected]
24 changes: 19 additions & 5 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/mwouts/jupytext
rev: v1.14.1 # CURRENT_TAG/COMMIT_HASH
hooks:
- id: jupytext
args: [--sync]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: check-yaml
- id: check-added-large-files
Comment on lines +7 to +8
Copy link
Member

Choose a reason for hiding this comment

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

Let's also add these two here for things that we have not been super consistent on in the past: trailing-whitespace, end-of-file-fixer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I actually had them in originally, I removed them because of the huge amount of changes all over the place that they would require. should I commit those changes as part of this PR as well?

Copy link
Member

Choose a reason for hiding this comment

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

I see, does this affect the workshops/ folder again or also analyses/? The former acts as more of a long term storage for material shown previously and we don't necessarily want to change it a lot, but for the latter I'd be happy to just apply all the changes.

Copy link
Member

Choose a reason for hiding this comment

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

Given that this might cause a lot of conflicts though it might be best to wait with that, it might make rebasing #158 a lot more difficult.


- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.0.272
hooks:
- id: ruff

- repo: https://github.com/mwouts/jupytext
rev: v1.14.6
hooks:
- id: jupytext
args: [--sync]
3 changes: 3 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[tool.ruff]
# ignore too long lines and ; at the end of a line
ignore = ["E501", "E703"]

[tool.jupytext]
formats = "ipynb,py:percent"