cruft update (#420)

Fixes #418

## Summary by Sourcery

Update project automation and linting configuration to align with the
latest template and pinned GitHub Actions versions.

Enhancements:
- Adjust Ruff and typos configuration to refine ignored rules and
identifiers and keep settings in sync with the template.
- Update tox documentation build message to point to the correct HTML
output path.

CI:
- Pin all GitHub Actions and shared workflows to specific commit SHAs
and bump them to their latest compatible versions across CI and
maintenance workflows.
- Annotate the label sync action with its current version and tweak
Dependabot cooldown settings for GitHub Actions updates.

Chores:
- Refresh pre-commit hook versions for security and tooling updates,
including zizmor and ruff.

Author: nabobalis

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "fb26c9794c872939b7e72bc7f30b943628384a8e",
+  "commit": "a31905a50a3889e42d9ca50065a4a4276ea62511",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -24,6 +24,7 @@
       "include_cruft_update_github_workflow": "y",
       "use_extended_ruff_linting": "y",
       "matrix_room_id": "",
+      "extra_ci_jobs": "",
       "_sphinx_theme": "sunpy",
       "_parent_project": "",
       "_install_requires": "",
@@ -33,7 +34,7 @@
         ".github/workflows/sub_package_update.yml"
       ],
       "_template": "https://github.com/sunpy/package-template",
-      "_commit": "fb26c9794c872939b7e72bc7f30b943628384a8e"
+      "_commit": "a31905a50a3889e42d9ca50065a4a4276ea62511"
     }
   },
   "directory": null

.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
     schedule:
       interval: "monthly"
     cooldown:
-      default-days: 7
+      default-days: 14  # Most updates should be from the package template
     groups:
       actions:
         patterns:

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ permissions: {}
 
 jobs:
   core:
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v3.0.1  # zizmor: ignore[unpinned-uses]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
     with:
       submodules: false
       coverage: codecov
@@ -44,10 +44,10 @@ jobs:
   sdist_verify:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v7  # zizmor: ignore[unpinned-uses]
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
         with:
           persist-credentials: false
-      - uses: actions/setup-python@v7  # zizmor: ignore[unpinned-uses]
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97  # v7.0.0
         with:
           python-version: '3.14'
       - run: python -m pip install -U --user build
@@ -57,7 +57,7 @@ jobs:
 
   test:
     needs: [core, sdist_verify]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v3.0.1  # zizmor: ignore[unpinned-uses]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
     with:
       submodules: false
       coverage: codecov
@@ -72,7 +72,7 @@ jobs:
 
   docs:
     needs: [core]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v3.0.1  # zizmor: ignore[unpinned-uses]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
     with:
       default_python: '3.13'
       submodules: false
@@ -123,7 +123,7 @@ jobs:
         contains(github.event.pull_request.labels.*.name, 'Run publish')
       )
     needs: [test, docs]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v3.0.1  # zizmor: ignore[unpinned-uses]
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
     with:
       python-version: '3.13'
       test_extras: 'all,tests'
@@ -143,7 +143,7 @@ jobs:
       name: pypi
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v8  # zizmor: ignore[unpinned-uses]
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
         with:
           merge-multiple: true
           pattern: dist-*
@@ -152,4 +152,4 @@ jobs:
       - run: ls -lha dist/
 
       - name: Run upload
-        uses: pypa/gh-action-pypi-publish@ba38be9e461d3875417946c167d0b5f3d385a247  # v1.14.1
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33  # v1.14.2

.github/workflows/label_sync.yml

@@ -18,6 +18,6 @@ jobs:
     runs-on: ubuntu-latest
     name: Label Sync
     steps:
-      - uses: srealmoreno/label-sync-action@850ba5cef2b25e56c6c420c4feed0319294682fd
+      - uses: srealmoreno/label-sync-action@850ba5cef2b25e56c6c420c4feed0319294682fd  # v2.0.0
         with:
           config-file: https://raw.githubusercontent.com/sunpy/.github/main/labels.yml

.github/workflows/sub_package_update.yml

@@ -22,11 +22,11 @@ jobs:
       contents: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v7  # zizmor: ignore[unpinned-uses]
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
         with:
           persist-credentials: false
 
-      - uses: actions/setup-python@v7  # zizmor: ignore[unpinned-uses]
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97  # v7.0.0
         with:
           python-version: "3.14"
 
@@ -79,7 +79,7 @@ jobs:
 
       - name: Create pull request
         if: steps.cruft_json.outputs.has_changes == '1'
-        uses: peter-evans/create-pull-request@v8  # zizmor: ignore[unpinned-uses]
+        uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1  # v8.1.1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           add-paths: "."
@@ -104,7 +104,7 @@ jobs:
       issues: write
     steps:
       - name: Open an issue if workflow fails
-        uses: actions/github-script@v9  # zizmor: ignore[unpinned-uses]
+        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3  # v9.0.0
         with:
           github-token: ${{ github.token }}
           # This script is adapted from https://github.com/scientific-python/issue-from-pytest-log-action

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 exclude: "(.*/)?CITATION.rst$|.*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|aiapy/extern)$"
 repos:
   - repo: https://github.com/zizmorcore/zizmor-pre-commit
-    rev: v1.26.1
+    rev: v1.28.0
     hooks:
       - id: zizmor
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.20"
+    rev: "v0.16.1"
     hooks:
       - id: ruff
         args: ["--fix", "--unsafe-fixes"]

_typos.toml

@@ -1,14 +1,15 @@
 default.extend-ignore-identifiers-re = [
+    "afile",
     "alog",
+    "CPY001",
+    "emiss",
+    "hsi_",
     "nd",
     "nin",
     "observ",
     "ot",
+    "precess",
+    "precessed",
     "te",
     "upto",
-    "afile",
-    "precessed",
-    "precess",
-    "emiss",
-    "hsi_",
 ]

ruff.toml

@@ -11,7 +11,6 @@ lint.extend-select = [
     "ALL",
 ]
 lint.extend-ignore = [
-    "I", # Ignore isort
     "ANN001", # Missing type annotation for function argument
     "ANN002", # Missing type annotation for variable
     "ANN003", # Missing type annotation for keyword
@@ -20,6 +19,7 @@ lint.extend-ignore = [
     "ANN205", # Missing return type annotation for staticmethod
     "ANN206", # Missing return type annotation for classmethod
     "COM812", # May cause conflicts when used with the formatter
+    "CPY001", # Missing copyright notice at top of file
     "D200", # One-line docstring should fit on one line
     "D205", # 1 blank line required between summary line and description
     "D400", # First line should end with a period
@@ -29,8 +29,10 @@ lint.extend-ignore = [
     "F403", # unable to detect undefined names,
     "FIX001", # Line contains FIXME, consider resolving the issue
     "FIX002", # Line contains TODO, consider resolving the issue
+    "I", # Ignore isort
     "ISC001", # May cause conflicts when used with the formatter
     "PLR0913", # Too many arguments in function definition
+    "PLR0917", # Too many positional arguments
     "PLR2004", # Magic value used in comparison
     "SLF001", # Private member accessed
     "TD001", # Invalid TODO tag: `FIXME`

tox.ini

@@ -28,9 +28,9 @@ pass_env =
     # If the user has set a LC override we should follow it
     LC_ALL
 set_env =
+    COVERAGE_FILE={toxinidir}/.coverage
     MPLBACKEND = agg
     devdeps: PIP_EXTRA_INDEX_URL = https://pypi.anaconda.org/astropy/simple https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
-    COVERAGE_FILE={toxinidir}/.coverage
 deps =
     # For packages which publish nightly wheels this will pull the latest nightly
     devdeps: astropy>=0.0.dev0
@@ -93,4 +93,4 @@ commands =
     _build/html \
     !gallery: -D plot_gallery=0 \
     {posargs}
-    python -c 'import pathlib; print("Documentation available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "docs" / "_build" / "index.html"))'
+    python -c 'import pathlib; print("Documentation available under file://\{0\}".format(pathlib.Path(r"{toxinidir}") / "docs" / "_build" / "html" / "index.html"))'