Skip to content

Expand TOML skip directories for release validation#122

Merged
leynos merged 4 commits intopython-lib-release-actionfrom
codex/action-unresolved-comments-on-pr-#90
Sep 23, 2025
Merged

Expand TOML skip directories for release validation#122
leynos merged 4 commits intopython-lib-release-actionfrom
codex/action-unresolved-comments-on-pr-#90

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Sep 22, 2025

Summary

  • include additional transient directories in validate_toml_versions skip list
  • extend the skip-directory test to cover the newly ignored paths

Testing

  • make test

https://chatgpt.com/codex/tasks/task_e_68d197d7cdd08322be2fb4b87d6cdeab

Summary by Sourcery

Expand the TOML validation skip list to cover additional transient directories and update tests to verify the new exclusions

Enhancements:

  • Extend the list of skipped directories in validate_toml_versions to include .pytest_cache, .cache, and htmlcov

Tests:

  • Update skip-directory test to assert the new skip directories are ignored and covered in SKIP_PARTS

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Sep 22, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR broadens the release validation skip list by adding additional transient directories to SKIP_PARTS and updates the corresponding tests to verify the new entries.

File-Level Changes

Change Details Files
Added new transient directories to the validation script’s skip list
  • Inserted ".pytest_cache", ".cache", and "htmlcov" into SKIP_PARTS
scripts/validate_toml_versions.py
Refactored tests to cover all ignored directories dynamically
  • Defined a skip_dirs set with the new entries
  • Asserted skip_dirs is a subset of module.SKIP_PARTS
  • Looped over each directory to write test pyproject files
tests/test_validate_toml_versions.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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 22, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/action-unresolved-comments-on-pr-#90

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

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

  • Consider parameterizing the skip-directory test so each directory case runs in isolation rather than looping in a single test invocation.
  • Instead of redefining skip_dirs in the test, import SKIP_PARTS from the module directly to keep the skip-list definition DRY and avoid duplication.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider parameterizing the skip-directory test so each directory case runs in isolation rather than looping in a single test invocation.
- Instead of redefining skip_dirs in the test, import SKIP_PARTS from the module directly to keep the skip-list definition DRY and avoid duplication.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Sep 22, 2025

@coderabbitai have the following now been resolved?

  • Consider parameterizing the skip-directory test so each directory case runs in isolation rather than looping in a single test invocation.
  • Instead of redefining skip_dirs in the test, import SKIP_PARTS from the module directly to keep the skip-list definition DRY and avoid duplication.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 22, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find test files that might contain skip directory tests
fd -e py test

# Search for files containing SKIP_PARTS or skip-directory related tests
rg -n "SKIP_PARTS|skip.dir" --type py

# Look for test parameterization patterns
rg -n "pytest.mark.parametrize|@pytest.mark.parametrize" --type py

Length of output: 11


🏁 Script executed:

#!/bin/bash
# Look for test files more broadly
find . -name "*test*.py" -type f

# Search for skip-related content in all Python files
rg -n -C3 "skip.*dir|SKIP_PARTS" --type py

# Look for validate_toml_versions function and related code
rg -n -C5 "validate_toml_versions" --type py

# Check the main module structure
ls -la

# Look for any Python files that might contain the main logic
fd -e py . | head -10

Length of output: 2976


🏁 Script executed:

#!/bin/bash
# Check the validate_toml_versions test file specifically
cat ./.github/actions/release-to-pypi-uv/tests/test_validate_toml_versions.py

# Also look at the main validate_toml_versions module to understand SKIP_PARTS
fd -e py validate_toml_versions .github/actions/release-to-pypi-uv/

Length of output: 10540


🏁 Script executed:

#!/bin/bash
# Look at the main validate_toml_versions script to see SKIP_PARTS definition
cat .github/actions/release-to-pypi-uv/scripts/validate_toml_versions.py

Length of output: 4592


@leynos Looking at the current test implementation, neither of the suggestions have been fully resolved:

  1. Test parameterization: The test_skips_files_in_ignored_directories test still uses a loop within a single test function rather than being parameterized. It currently does:

    for name in skip_dirs:
        _write_pyproject(project_root / name / "pkg", ...)

    To resolve this, the test would need to use @pytest.mark.parametrize to run each directory case in isolation.

  2. DRY principle: While the test does reference module.SKIP_PARTS for validation (assert skip_dirs <= module.SKIP_PARTS), it still redefines a subset locally:

    skip_dirs = {".venv", ".mypy_cache", ".pytest_cache", ".cache", "htmlcov"}

    To resolve this, the test should use module.SKIP_PARTS directly instead of redefining the directories.

The test would need to be refactored to something like:

@pytest.mark.parametrize("skip_dir", list(module.SKIP_PARTS))
def test_skips_files_in_ignored_directories(
    project_root: Path, module: ModuleType, skip_dir: str, capsys: pytest.CaptureFixture[str]
) -> None:
    # Test each directory individually

Both suggestions remain open for implementation.

@leynos leynos merged commit cf71acf into python-lib-release-action Sep 23, 2025
6 of 8 checks passed
@leynos leynos deleted the codex/action-unresolved-comments-on-pr-#90 branch September 23, 2025 06:55
leynos added a commit that referenced this pull request Sep 23, 2025
* Expand pyproject skip list handling

* Strengthen TOML and runtime timeout tests

* Assert cargo fallback logs podman failure

* Parameterize skip-directory regression
leynos added a commit that referenced this pull request Sep 24, 2025
* Expand pyproject skip list handling

* Strengthen TOML and runtime timeout tests

* Assert cargo fallback logs podman failure

* Parameterize skip-directory regression
leynos added a commit that referenced this pull request Sep 24, 2025
* Add release-to-pypi-uv composite action

* Document trusted publishing permissions

* Clarify GH_TOKEN handling in README

* Fix local usage example

* Improve GitHub release error handling

* Fix cmd_utils discovery in publish script

* Skip more build caches

* Fail fast on TOML parse errors

* Format release summary output

* Add no-tag error test

* Test TOML parse failures

* Make uv python version configurable

* Document concurrency guard in usage

* Address review feedback with retries and tests

* Improve TOML version validation and test strategy

Extends boolean parsing to support more truthy values when validating dynamic version flags in TOML files. Refactors tests to run in-process with better coverage of various flag values and scenarios, replacing subprocess-based tests for efficiency and detail. Updates action to simplify Python version handling with uv and improves path detection for testing.

These changes make validation logic more robust and enhance test reliability.

* Add cmd-mox users guide

* Use cmd-mox to stub rust build command tests (#92)

* Use cmd-mox for rust build command tests

* Guard cmd-mox integration on Windows

* Refactor cmd-mox helpers into shared conftest

* Apply cmd-mox fake which simplification

* Mark Windows smoke tests as xfail (#94)

* Mark Windows smoke tests as xfail

* Tighten Windows smoke test expectations

* Address reviewer feedback for release-to-pypi-uv action (#98)

* Address review comments for release to PyPI action

* Add tests and docs for python-version handling

* Fix cmd_mox fixture usage and expose dev extra (#101)

* Fix cmd_mox fixture usage and expose dev extras

* Remove pyproject optional dev extra

* Remove Pyright configuration

* Add missing docstrings to release-to-pypi-uv modules (#103)

* Silence type-check import lints for release action (#104)

* Add toolchain-specific cargo cache key and clean shellstub imports (#88)

* Address review feedback for shellstub imports

* Fix MSYS2 install comments breaking pacman (#89)

* Fix MSYS2 install comments breaking pacman

* Fix Windows llvm-mingw metadata export

* Handle runtime detection timeouts

* Fix rust host detection timeout and Windows bin path (#91)

* Fix rust host detection timeout and Windows bin path

* Add timeout coverage for rust host detection

* Unify runtime probe timeout configuration

* test: capture rustc probe kwargs in timeout test

* Remove inline comments from Windows GNU MSYS2 package list (#99)

* Remove inline MSYS2 install comments

* Skip nfpm steps on Windows builds

* Handle nfpm packaging only for Linux

* Fix Windows invocation of rust-build-release (#102)

* Silence type-check import lints for release action

* Adds ignore rule for Crush agent artifacts

Ignores files generated by the Crush AI agent to prevent them from being tracked in version control.

Adds a symlink to AGENTS.md for discovery by Crush

* Format code after rebase validation to satisfy repo style checks.

💘 Generated with Crush
Co-Authored-By: Crush <crush@charm.land>

* fmt: extend fmt target to run ruff check --select D202,I001 --fix; apply resulting fixes

💘 Generated with Crush
Co-Authored-By: Crush <crush@charm.land>

---------

Co-authored-by: Payton McIntosh <pmcintosh@df12.net>
Co-authored-by: Crush <crush@charm.land>

* Narrow module fixtures to ModuleType (#105)

* Add docstrings for release-to-pypi-uv tests and helpers (#106)

* Add missing docstrings for release-to-pypi-uv tests

* Simplify cmd-mox typing and streamline docstrings

* Apply formatting

* chore: remove unused imports across scripts and tests

* style(_helpers): alphabetise __all__ tuple

* tests: drop superfluous parentheses from @pytest.fixture usage

---------

Co-authored-by: Payton McIntosh <pmcintosh@df12.net>

* Scope type-checking imports (#111)

* Scope type-checking imports

* Fix lint warnings across release scripts

* Clarify cargo stream capture error

* ci: add lint and format checks

* Install action-validator in CI lint workflow

* Install bun validator packages in CI

* Test full success message for matching versions (#113)

* Address review comments (#116)

* Address review feedback for release-to-pypi-uv actions (#112)

* Address review feedback

* Add CLI coverage for publish and validate scripts

* Add deterministic validation tests and bunx validator checks

* Update ci.yml remove unneeded step

* Fix formatting

* Fix Windows xfail marker removal for pytest 8 (#120)

* Fix Windows xfail marker removal for pytest 8

* Tighten Windows xfail marker filtering

* Handle runtime probe timeouts and expand release tests (#119)

* Handle runtime probe timeouts and expand release tests

* Add _probe_runtime coverage and assert timeout warnings

* Expand TOML skip directories for release validation (#122)

* Expand pyproject skip list handling

* Strengthen TOML and runtime timeout tests

* Assert cargo fallback logs podman failure

* Parameterize skip-directory regression

* Reinforce regression coverage for release tooling (#130)

* Refine skip directory regression parameterization

* Document skip directories and DRY timeout assertions

* Parametrize publish index test

* Refactor runtime timeout tests

* Rebase onto origin/python-lib-release-action and resolve conflicts

- Resolve merge in validate_toml_versions tests by standardizing module loading
- Register dynamically loaded scripts in sys.modules to support reload semantics
- Make toolchain triple test robust to host arch by selecting matching target
- Run formatting, lint, typecheck, and tests to validate integration

💘 Generated with Crush
Co-Authored-By: Crush <crush@charm.land>

---------

Co-authored-by: Crush <crush@charm.land>

* Harden release-to-pypi-uv workflow and regression coverage (#134)

* Improve release validation jitter handling

* Adjust runtime fallback host triples per platform

* Make release validation deterministic and configurable

* Rebase python-lib-release-action onto origin/main; resolve conflicts preserving branch intent; drop uv.lock in favor of main; fix tests and typing/lint issues; all tests pass and linters clean

* Close cargo pipes when coverage stream missing (#137)

* Close cargo pipes when missing

* Ensure cargo pipes close on all paths

* Ensure guard closes cargo pipes before exiting

* Handle release script auth failure and multiline outputs (#136)

* Handle release script auth failure and multiline outputs

* Harden windows toolchain setup and extend runtime tests

* Handle release auth errors and tweak toolchain retries

* Fix cross install warning expectation (#139)

* Fix cross install warning assertion

* Harden cross install harness checks

* Sanitize runtime probe timeout and guard actions

* Refine runtime probe helpers and add timeout tests

* Fix runtime probe lint findings

* Share echo recorder fixture across runtime tests

* Update fmt target description (#140)

* Resolve rebase conflicts and align runtime tests with platform/timeouts from main while preserving branch improvements; ensure formatting passes and all tests/linters are green.

💘 Generated with Crush
Co-Authored-By: Crush <crush@charm.land>

---------

Co-authored-by: Payton McIntosh <pmcintosh@df12.net>
Co-authored-by: Crush <crush@charm.land>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant