Skip to content

CI: Add pre-commit CI#472

Merged
pc494 merged 3 commits into
pyxem:developfrom
CSSFrancis:add_precommit_ci
Mar 26, 2024
Merged

CI: Add pre-commit CI#472
pc494 merged 3 commits into
pyxem:developfrom
CSSFrancis:add_precommit_ci

Conversation

@CSSFrancis
Copy link
Copy Markdown
Member

@CSSFrancis CSSFrancis commented Mar 26, 2024

CI: Add pre-commit CI

This adds lines to pre-commit for CI to run isort and black from a comment to a PR.

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in
    .zenodo.json.

@CSSFrancis
Copy link
Copy Markdown
Member Author

@pc494 Can you add access to orix from https://pre-commit.ci

This was referenced Mar 26, 2024
@pc494
Copy link
Copy Markdown
Member

pc494 commented Mar 26, 2024

pre-commit.ci autofix

@pc494
Copy link
Copy Markdown
Member

pc494 commented Mar 26, 2024

at a guess this failure is due to the style changes between 2023 and 2024. @CSSFrancis could you run locally so this comes up green as I imagine we need this merged before we can autofix.

@CSSFrancis
Copy link
Copy Markdown
Member Author

@pc494 Yep you are correct. The joys of running black :)

@CSSFrancis
Copy link
Copy Markdown
Member Author

@pc494 This should be fixed now and we can auto fix now which is nice.

@pc494 pc494 added dev Package maintenance tests Relates to the tests labels Mar 26, 2024
Comment thread .pre-commit-config.yaml
repos:
- repo: https://github.com/psf/black
rev: 23.1.0
rev: 24.3.0
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Good.

@pc494
Copy link
Copy Markdown
Member

pc494 commented Mar 26, 2024

I am going to merge this on the condition that @CSSFrancis remembers to add himself to the Zenodo when we get to #460. This PR closes #463.

@pc494 pc494 merged commit 8f98c15 into pyxem:develop Mar 26, 2024
@pc494 pc494 added this to the v0.12.0 milestone Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev Package maintenance tests Relates to the tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants