The template for `.pre-commit-config.yaml` has been updated

Open Beginner friendly
#430 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
github-actions
Domain
ci-cd

Research direction

Compare .pre-commit-config.yaml in this repository with templates/.pre-commit-config.yaml in the SciTools/.github repository, starting with the supplied diff and then reviewing the full template difference. Done means applying the appropriate shared changes in this repository or closing the issue if none are appropriate.

Written by the indexing model from the issue text.

Description

Templating

The template for .pre-commit-config.yaml has been updated; see the diff below. Please either:

  • Action this issue with a pull request applying some/all of these changes to .pre-commit-config.yaml[^1].
  • Close this issue if none of these changes are appropriate for this repo.

Also consider reviewing a full diff between the template and .pre-commit-config.yaml, in case other valuable shared conventions have previously been missed.

File Links

Diff

diff --git a/templates/.pre-commit-config.yaml b/templates/.pre-commit-config.yaml
index 080e90e..35f2ab2 100644
--- a/templates/.pre-commit-config.yaml
+++ b/templates/.pre-commit-config.yaml
@@ -13,6 +13,7 @@ ci:
 # Alphabetised, for lack of a better order.
 files: |
     (?x)(
+        .github\/workflows\/.*|
         benchmarks\/.+\.py|
         docs\/.+\.py|
         lib\/.+\.py|
@@ -120,3 +121,9 @@ repos:
     hooks:
     - id: validate-pyproject
 
+-   repo: https://github.com/zizmorcore/zizmor-pre-commit
+    # This template does not keep up-to-date with versions, visit the repo to see the most recent release.
+    rev: v1.25.2
+    hooks:
+    - id: zizmor
+

[^1]: Include this text in the PR body to avoid any prompts about applying your changes back to the template!
@scitools-templating: please no share prompt

Dominant language
Jupyter Notebook
Stars
30
Forks
19
Avg merge
9d 1h
Merged PRs (30d)
2

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SciTools/python-stratify

All issues in SciTools/python-stratify

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.