Skip to content

chore: reorder project #256

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 1 commit into from
Jun 18, 2025
Merged

chore: reorder project #256

cesarcoatl merged 1 commit into from
Jun 18, 2025

Conversation

@cesarcoatl
Copy link
Member

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

rename pkg to incendium
rename stubs to incendium-stubs
fix paths on .pre-commit-config.yaml and workflows

Summary by Sourcery

Rename the main package directory to "incendium" and the stubs directory to "incendium-stubs", and update all corresponding configuration, workflow, documentation, and tooling references.

Enhancements:

  • Rename source directory pkg to incendium and stubs directory to incendium-stubs.
  • Update pre-commit hook paths to reference the new directory names.
  • Adjust GitHub Actions workflows, pip-compile upgrade steps, and tox configurations to use incendium and incendium-stubs paths.
  • Refresh README links, .cz.toml version files, devcontainer setup, and other configuration files to reflect the renamed directories.
  • Specify temurin as the java-distribution in the Jython CI setup.

@cesarcoatl
chore: reorder project
d6aa211 
rename pkg to incendium
rename stubs to incendium-stubs
fix paths on .pre-commit-config.yaml and workflows
@sourcery-ai
Copy link
Contributor

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

Reviewer's Guide

This PR restructures the repository by renaming the primary package directory (pkg) to incendi­um and the stubs directory to incendi­um-stubs, updating all path references in configuration, CI workflows, documentation, and tooling setups to match the new layout.

File-Level Changes

Change Details Files
Rename main package directory from pkg to incendi­um
  • Move pkg/ → incendium/ and update directory layout
  • Adjust COPY path in .devcontainer/Dockerfile
  • Update working-directory in jython.yml and ci.yml steps
  • Revise stubgen output path in tox.ini
 .devcontainer/Dockerfile
.github/workflows/jython.yml
.github/workflows/ci.yml
incendium/tox.ini
incendium/README.md
Rename stubs directory to incendi­um-stubs and update related references
  • Move stubs/ → incendi­um-stubs/ and adjust file patterns
  • Update hook file patterns and config args in .pre-commit-config.yaml
  • Adjust working-directory and job names for stub pipelines in pr-build, publish, and pip-compile-upgrade
  • Revise documentation links and version_files entries in cz.toml
 .pre-commit-config.yaml
.github/workflows/pr-build.yml
.github/workflows/publish.yml
.github/workflows/pip-compile-upgrade.yml
README.md
incendium-stubs/README.md
cz.toml
Update CI workflow job names and path filters to align with the new structure
  • Rename tox-docker → tox-incendium and tox-gh → tox-incendium-stubs jobs
  • Rename publish-pkg/stubs → publish-incendium/incendium-stubs jobs
  • Update path filters under on.push/paths in pr-build.yml and publish.yml
 .github/workflows/pr-build.yml
.github/workflows/publish.yml
Add explicit Java distribution parameter for Jython in CI
  • Include java-distribution: temurin in the setup-jython step
 .github/workflows/jython.yml
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 18, 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!

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.

@cesarcoatl cesarcoatl merged commit b9cf3c2 into main Jun 18, 2025
8 checks passed
@cesarcoatl cesarcoatl deleted the chore/reorg branch June 18, 2025 22:10
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