Skip to content

Various minor local dev/ci improvements#158

Merged
TimothyWillard merged 1 commit intomainfrom
local-dev-ci-improvements
Feb 23, 2026
Merged

Various minor local dev/ci improvements#158
TimothyWillard merged 1 commit intomainfrom
local-dev-ci-improvements

Conversation

@TimothyWillard
Copy link
Collaborator

@TimothyWillard TimothyWillard commented Feb 19, 2026

  • Added code coverage check to local development via just cov as well
    as incorporating into CI by running them for python version 3.12 and
    then opting to just run the unit tests as is for other versions.
  • Automatically mark tests in the tests/integration/ directory with an
    "integration" pytest marker to differentiate them and make them easier
    to run separately.
  • Consolidated settings from justfile into pyproject.toml for ruff
    and mypy.
  • Refactored justfile for local development UX and updated CI checks
    to do the same as local checks when possible.
  • Refactored ci.yaml workflow to split code quality checks from tests.
  • Updated CONTRIBUTING.md to reflect the changes made above.
  • Reenabled linting/formatting/type checking/testing of code within the
    docs/ directory, which identified an issue with both the getting
    started example and the implementing a custom engine example.
    Closes Update "Approach 2: Custom build Function" section of "Creating an External Provider Package" guide #152.
  • Added repo_root fixture to conftest.py for internal testing
    purposes, simplifies integration tests.
  • Consolidated the steps to setup uv and just into a custom composite
    action named 'setup-just-and-uv' to DRY across the custom workflows.
    Also switched from installing just manually to using
    'extractions/setup-just@v3' to obtain a more recent version of just.

@TimothyWillard
Copy link
Collaborator Author

Follow ups:

  • Consider splitting out integration tests, especially if we add more and they start taking considerably more time.
  • Issues for increasing the coverage for key pieces of code currently not well covered (the simulate/skeleton/process commands, etc.)

@TimothyWillard TimothyWillard marked this pull request as draft February 19, 2026 15:26
@TimothyWillard TimothyWillard force-pushed the local-dev-ci-improvements branch from 98d67f2 to 9a83aee Compare February 19, 2026 15:36
@TimothyWillard TimothyWillard marked this pull request as ready for review February 19, 2026 15:39
@TimothyWillard TimothyWillard self-assigned this Feb 19, 2026
Copy link
Member

@pearsonca pearsonca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Per conversation - would be nice to DRY out the workflows a bit. Had one curiousity note re CONTRIBUTING doc - I think TOCs are useful, though certainly not required.

Comment on lines -5 to -13
## Table of Contents

- [Development Setup](#development-setup)
- [Code Standards](#code-standards)
- [Testing](#testing)
- [Documentation](#documentation)
- [Pull Request Process](#pull-request-process)
- [Reporting Issues](#reporting-issues)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i forget: does GFM provide some auto navigation to manage this?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is the toggle in the upper right of the markdown viewer that brings up the section headings (see screenshot below). Although this is probably more detailed than desired. I removed this not have duplicate tables of content on this page: https://accidda.github.io/flepimop2/latest/development/contributing/. But if you would prefer the explicit table of contents at the top of the document on GitHub I can find some other solutions.

Screenshot 2026-02-23 at 9 38 16 AM

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's what i was getting at - definitely no need for a manual TOC when Github automatically extracts.

@TimothyWillard TimothyWillard force-pushed the local-dev-ci-improvements branch from 6f53e09 to 9d9cc54 Compare February 23, 2026 20:12
- Added code coverage check to local development via `just cov` as well
  as incorporating into CI by running them for python version 3.12 and
  then opting to just run the unit tests as is for other versions.
- Automatically mark tests in the `tests/integration/` directory with an
  "integration" pytest marker to differentiate them and make them easier
  to run separately.
- Consolidated settings from `justfile` into `pyproject.toml` for `ruff`
  and `mypy`.
- Refactored `justfile` for local development UX and updated CI checks
  to do the same as local checks when possible.
- Refactored `ci.yaml` workflow to split code quality checks from tests.
- Updated `CONTRIBUTING.md` to reflect the changes made above.
- Reenabled linting/formatting/type checking/testing of code within the
  `docs/` directory, which identified an issue with both the getting
  started example and the implementing a custom engine example.
  Closes #152.
- Added `repo_root` fixture to `conftest.py` for internal testing
  purposes, simplifies integration tests.
- Consolidated the steps to setup uv and just into a custom composite
  action named 'setup-just-and-uv' to DRY across the custom workflows.
  Also switched from installing `just` manually to using
  'extractions/setup-just@v3' to obtain a more recent version of `just`.
@TimothyWillard TimothyWillard force-pushed the local-dev-ci-improvements branch from 9d9cc54 to e1fc745 Compare February 23, 2026 20:15
@TimothyWillard
Copy link
Collaborator Author

Not going to re-request review for this change, but extracted out the setup for just & uv out to a composite action. Net of changes is: https://github.com/ACCIDDA/flepimop2/compare/9a83aee023df5145731589c7c6f5941a6e7070ac..e1fc745c5c29039d339d04788623618818a7e462.

@TimothyWillard TimothyWillard merged commit 719cc3a into main Feb 23, 2026
7 checks passed
@TimothyWillard TimothyWillard deleted the local-dev-ci-improvements branch February 23, 2026 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "Approach 2: Custom build Function" section of "Creating an External Provider Package" guide

2 participants