add more tests

[joamatab]

• fix typo
• add more tests

Summary by Sourcery

Update CI workflows and documentation comments for coupler ring models.

CI:

• Configure test workflow concurrency and GFP API key environment variable.
• Add a dedicated GFP test job using Python 3.12 and uv.
• Update the docs build workflow to use Python 3.12.

Documentation:

• Fix typos in coupler ring model docstrings regarding accuracy guarantees.

[sourcery-ai]

Reviewer's Guide

Updates CI workflows to run tests with Python 3.12 and GFP-specific tests, adds workflow-level concurrency and environment configuration, and fixes a couple of documentation typos in a ring coupler model docstring.

Sequence diagram for updated test workflow with Python_3_12_and_GFP_tests

sequenceDiagram
  actor Developer
  participant Repo
  participant GitHubActions
  participant TestWorkflow
  participant Python312
  participant UV
  participant TestRunner

  Developer->>Repo: Push code or open PR
  Repo->>GitHubActions: Trigger test_code workflow
  GitHubActions->>TestWorkflow: Start workflow job

  TestWorkflow->>GitHubActions: Request setup-python v5 with version 3.12
  GitHubActions->>Python312: Provision Python 3.12 environment
  Python312-->>GitHubActions: Python 3.12 ready

  TestWorkflow->>GitHubActions: Run astral-sh/setup-uv@v7
  GitHubActions->>UV: Install uv
  UV-->>GitHubActions: uv available

  TestWorkflow->>UV: Install project and test dependencies
  UV-->>TestWorkflow: Dependencies installed

  TestWorkflow->>TestRunner: Execute test suite (including GFP-specific tests)
  TestRunner-->>TestWorkflow: Test results
  TestWorkflow-->>GitHubActions: Job status
  GitHubActions-->>Developer: Report CI status on PR

Loading

File-Level Changes

Change	Details	Files
Add workflow-level concurrency control and shared environment for test workflow.	Configure workflow-level concurrency to cancel in-progress runs for the same workflow/ref pair. Define a workflow-wide GFP_API_KEY environment variable sourced from GitHub secrets for all jobs.	.github/workflows/test_code.yml
Introduce a dedicated GFP test job in CI.	Add a new test_gfp job that checks out the repo, sets up Python 3.12, installs uv, installs dependencies via make, and runs GFP tests with uv run gfp test. Reuse similar setup steps as the pre-commit job to keep GFP tests consistent with main test setup.	.github/workflows/test_code.yml
Standardize Pages workflow to Python 3.12.	Update the GitHub Pages workflow to use Python 3.12 instead of 3.11 for docs/site-related tasks.	.github/workflows/pages.yml
Fix typos in ring coupler model docstrings.	Correct the spelling of 'guaranee' to 'guarantee' in two coupler ring-related model docstrings to improve clarity/documentation quality.	ubcpdk/models/couplers.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Consider scoping GFP_API_KEY to only the jobs that actually need it rather than defining it at the workflow level to reduce unnecessary secret exposure.
• The pre-commit, test, and new test_gfp jobs duplicate much of the Python/uv setup and install steps; you could factor these into a reusable action or job configuration to make the workflow easier to maintain.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider scoping `GFP_API_KEY` to only the jobs that actually need it rather than defining it at the workflow level to reduce unnecessary secret exposure.
- The `pre-commit`, `test`, and new `test_gfp` jobs duplicate much of the Python/uv setup and install steps; you could factor these into a reusable action or job configuration to make the workflow easier to maintain.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}