Update minimum python and package versions and template - #19
Conversation
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
615cae5 to
8c7ac20
Compare
8c7ac20 to
bbce0e3
Compare
There was a problem hiding this comment.
🟡 Changes recommended
Several CI/automation files contain unrendered cookiecutter placeholders and workflow permission blocks that will prevent GitHub Actions jobs from running successfully.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates SMARTpy’s project scaffolding to align with a newer SunPy package template, raising the supported Python/dependency floor and modernizing CI/docs tooling.
Changes:
- Bump minimum supported Python to 3.12 and update key dependency minimums (e.g.,
sunpy[map],scikit-image). - Refresh CI/pre-commit/Ruff configuration and GitHub Actions workflows (including Codecov OIDC + new security/maintenance workflows).
- Add/extend changelog + “what’s new” documentation plumbing (Towncrier + Sphinx changelog integration).
File summaries
| File | Description |
|---|---|
| tox.ini | Update tox env matrix and set COVERAGE_FILE for consistent coverage output. |
| smart/tests/test_map_processing.py | Make fixtures session-scoped and reformat one assertion. |
| smart/tests/test_calculate_properties.py | Reformat map URL fixture construction. |
| smart/indexed_grown_mask.py | Reformat function signature to a single line. |
| smart/_dev/scm_version.py | Switch to pathlib.Path for setuptools_scm root handling. |
| smart/_dev/init.py | Fix dev-package docstring wording. |
| README.rst | Replace license/disclaimer section with AI-usage + contribution pointers. |
| pyproject.toml | Raise requires-python, bump dependencies, update setuptools_scm config, add URLs and docs deps. |
| MANIFEST.in | Exclude/prune additional template/CI files from source distributions. |
| licenses/LICENSE.rst | Adjust BSD clause naming. |
| docs/whatsnew/index.rst | Add release-history index page. |
| docs/whatsnew/changelog.rst | Add sphinx-changelog directive wired to Towncrier/CHANGELOG. |
| docs/index.rst | Add “what’s new” to the docs toctree and add indices/tables. |
| docs/conf.py | Improve version rendering logic and enable sphinx-changelog + graphviz settings. |
| changelog/README.rst | Expand guidance for writing Towncrier news fragments. |
| changelog/19.breaking.rst | Add breaking-change fragment documenting dependency floor bumps. |
| CHANGELOG.rst | Included in PR context (no diff shown). |
| .ruff.toml | Update target version/line length and expand lint/isort configuration. |
| .rtd-environment.yml | Bump RTD conda environment Python to 3.12. |
| .readthedocs.yaml | Modernize RTD build image/toolchain selection. |
| .pre-commit-config.yaml | Update hooks (Ruff-format replacing isort) and add sphinx-lint/codespell improvements. |
| .isort.cfg | Remove legacy isort configuration (migrated to Ruff isort settings). |
| .github/workflows/zizmor.yml | Add zizmor GitHub Actions security analysis workflow. |
| .github/workflows/sub_package_update.yml | Harden and extend cruft-based template update workflow. |
| .github/workflows/label_sync.yml | Add scheduled label-sync workflow. |
| .github/workflows/ci.yml | Update CI to OA reusable workflows, add publish workflow pieces, and enable Codecov OIDC. |
| .github/dependabot.yml | Add Dependabot config for GitHub Actions updates. |
| .cruft.json | Update cruft template commit and context defaults. |
| .coveragerc | Exclude smart/_dev from coverage collection. |
Review details
- Files reviewed: 28/29 changed files
- Comments generated: 12
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
No description provided.