Skip to content

[Bug]: Project CI does not isolate pre-commit and docs testing #49

@harryswift01

Description

@harryswift01

Bug Report

Although the CI workflow defines separate tests, docs, and pre-commit jobs, the test environments and dependencies are not fully isolated, leading to unnecessary coupling between pre-commit checks, documentation builds, and test-related failures.

In the current CI configuration:

  • The pre-commit job installs testing, documentation, and pre-commit dependencies together, for example:
    • pip install -e .[pre-commit,docs,testing]
  • The docs and pre-commit jobs rely on overlapping dependency extras and shared environments.
  • As a result, failures originating from documentation dependencies or configuration can cause the pre-commit job to fail (and vice versa), even when formatting and linting are otherwise correct.

This coupling reduces CI clarity and makes failures harder to diagnose, as issues may surface in jobs that are not directly responsible for the failing component.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions