Skip to content

test(tox): remove root tox.ini #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
cesarcoatl merged 3 commits into from
Jun 17, 2025
Merged

test(tox): remove root tox.ini #253

cesarcoatl merged 3 commits into from
Jun 17, 2025

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Jun 17, 2025 •
edited by sourcery-ai bot
Loading

move it back to each package

Summary by Sourcery

Move Tox configuration from the project root into each package and update CI workflows accordingly

Enhancements:

  • Remove root tox.ini and introduce pkg/tox.ini with dedicated test, typecheck, stubgen, and style environments

CI:

  • Include '**/tox.ini' in the GitHub Actions path filters and adjust Tox jobs to run within pkg and stubs working directories

Documentation:

  • Add pkg/CHANGELOG.md that references the project’s root changelog

@cesarcoatl
test(tox): remove root tox.ini
2980eb7 
move it back to each package
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 17, 2025 •
edited
Loading

Reviewer's Guide

This PR migrates the repository-level tox configuration into the pkg directory, updates CI workflows to invoke tox from the new locations, and adds a per-package changelog stub.

Class diagram for new pkg/tox.ini test environments

classDiagram
    class ToxConfig {
      +env_list: install, typecheck
    }
    class TestEnvInstall {
      +description: install package
      +base_python: python2.7
    }
    class TestEnvTypecheck {
      +description: run type check on code base
      +base_python: python3.12
      +commands: mypy src
    }
    class TestEnvStubgen {
      +description: generate stubs
      +base_python: python3.12
      +commands: stubgen --export-less --output=../incendium-stubs/stubs src
    }
    class TestEnvStyle {
      +description: apply style
      +base_python: python3.12
      +commands: sort-all, ssort, black, unimport, isort, flake8, pydocstyle
    }
    ToxConfig --> TestEnvInstall
    ToxConfig --> TestEnvTypecheck
    ToxConfig --> TestEnvStubgen
    ToxConfig --> TestEnvStyle
Loading

File-Level Changes

Change Details Files
Refactor tox setup to package scope
  • Remove the root tox.ini
  • Add pkg/tox.ini defining install, typecheck, stubgen, and style testenvs
  • Introduce shared type-base settings under [type]
 tox.ini
pkg/tox.ini
Adapt CI workflows for new tox locations
  • Include '**/tox.ini' in GitHub Actions path filters
  • Remove the old tox.ini filter
  • Set working-directory to pkg for the tox-docker job
  • Set working-directory to stubs for the tox-gh job
 .github/workflows/pr-build.yml
Add package-level changelog stub
  • Create pkg/CHANGELOG.md pointing to the central CHANGELOG
 pkg/CHANGELOG.md
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

sourcery-ai[bot]
sourcery-ai bot reviewed Jun 17, 2025
View reviewed changes
Copy link
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 @cesarcoatl - I've reviewed your changes and they look great!

Prompt for AI Agents 
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `pkg/tox.ini:58` </location>
<code_context>
+[type]
+base_python = python3.12
+deps =
+    ignition-api-stubs
\ No newline at end of file
</code_context>

<issue_to_address>
Dependency on ignition-api-stubs is not version-pinned.

Please specify a version or version range for ignition-api-stubs to ensure build stability and reproducibility.
</issue_to_address>
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.

pkg/tox.ini
[type]
base_python = python3.12
deps =
ignition-api-stubs No newline at end of file
Copy link
Contributor

@sourcery-ai sourcery-ai bot Jun 17, 2025

Choose a reason for hiding this comment

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

suggestion (bug_risk): Dependency on ignition-api-stubs is not version-pinned.

Please specify a version or version range for ignition-api-stubs to ensure build stability and reproducibility.

@cesarcoatl cesarcoatl merged commit fb0d89d into main Jun 17, 2025
8 checks passed
@cesarcoatl cesarcoatl deleted the test/tox/split branch June 17, 2025 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cesarcoatl