Skip to content

Move to the shared CCPBioSim workflows and standardise repo - #80

Merged
harryswift01 merged 19 commits into
mainfrom
79-feature-move-to-the-shared-ccpbiosim-workflows
Oct 27, 2026
Merged

harryswift01 merged 19 commits into
mainfrom
79-feature-move-to-the-shared-ccpbiosim-workflows

Conversation

@harryswift01

Copy link
Copy Markdown
Member

Summary

This PR moves Python-Template onto the shared CCPBioSim workflows, Renovate presets and community files in CCPBioSim/.github, and aligns its layout with CodeEntropy so that new packages created from the template start with the same setup as the existing packages. Closes #79.

Changes

Shared CI workflows:

  • Replace example_package_project-ci.yaml with pr.yaml, weekly-tests.yaml, coveralls-main.yaml and weekly-docs.yaml, calling the shared workflows pinned to release 0.13.0.
  • Pull requests run unit tests on ubuntu-26.04, macos-26 and windows-2025-vs2026 across Python 3.12–3.14, with coverage and the lowest-dependencies check, plus docs, pre-commit and a conda build check.
  • The weekly runs repeat the tests with the lowest-dependencies check and build the docs on all three operating systems.
  • The license-year workflow calls the shared maintenance-license-year workflow.

Release pipeline:

  • release.yaml uses the shared release-prepare, release-website, release-pypi and release-conda workflows, matching CodeEntropy.
  • Fix the version file path, which pointed at src/example_package/__init__.py, a layout the template does not use.
  • Add conda-recipe/meta.yaml, which reads requires-python and the runtime dependencies from pyproject.toml.
  • Add .github/web-meta.yaml with placeholder metadata for the CCPBioSim website.

Docs and tests layout:

  • Move the Sphinx sources from docs/source to docs, build into docs/_build, and remove make.bat, matching CodeEntropy.
  • Align conf.py with CodeEntropy: repository root on sys.path, a rolling copyright year and Google-style docstrings.
  • Add the missing _static and _templates directories, so the docs build passes with warnings as errors.
  • Move the tests under tests/unit.

Project configuration:

  • Use the CodeEntropy ruff rules (E, F, I, B, UP).
  • Replace the --cov pytest options with -vv -ra, so the shared workflow controls where coverage is measured.
  • Add rstcheck to the pre-commit extra, cap ruff below 1.0, and drop unused Sphinx extensions from the docs extra.

Shared Renovate and community files:

  • .github/renovate.json extends the shared renovate/default and renovate/python presets.
  • Remove the local issue templates, pull request template and contributing guidelines, so the organisation defaults apply.
  • Update the README badges for the new workflows and add Citation and Anaconda rows.

Impact

  • New packages created from the template get the same CI, release and Renovate setup as the existing CCPBioSim packages, and CI fixes made in CCPBioSim/.github reach them through Renovate pin updates.
  • Pull requests now test on Linux, macOS and Windows, and the docs build fails on warnings, so some problems that previously passed will now be caught.
  • Running pytest locally no longer reports coverage by default. Pass --cov example_package to see it.
  • A real release of the template now publishes to the CCPBioSim website and Anaconda.org as well as PyPI, so test releases should use dry-run: true.
  • The Citation badge uses a placeholder Zenodo ID until a package fills in its own.

@harryswift01 harryswift01 self-assigned this Oct 27, 2026
@harryswift01 harryswift01 added the enhancement New feature or request label Oct 27, 2026
@harryswift01 harryswift01 linked an issue Oct 27, 2026 that may be closed by this pull request
@harryswift01
harryswift01 merged commit 2e84f84 into main Oct 27, 2026
14 checks passed
@harryswift01
harryswift01 deleted the 79-feature-move-to-the-shared-ccpbiosim-workflows branch October 27, 2026 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Move to the shared CCPBioSim workflows

1 participant