Skip to content

chore: migrated PR 3968 #3971

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.

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

Merged
merged 5 commits into from
May 30, 2025
Merged

chore: migrated PR 3968 #3971

merged 5 commits into from
May 30, 2025

Conversation

pyansys-ci-bot
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot commented May 29, 2025

This PR was migrated from a fork to allow secrets to run in workflows. Check the original PR for more details.

Closes #3968

Summary by Sourcery

Migrate and consolidate upstream PR 3968 by reformatting and reorganizing the pyproject.toml structure and adding a TOML formatter hook.

Enhancements:

  • Normalize metadata, dependencies, optional-dependencies, classifiers, scripts, and project URLs ordering and formatting in pyproject.toml
  • Standardize configuration sections (pytest, isort, coverage, codespell, numpydoc, mypy, towncrier) in pyproject.toml

CI:

  • Add taplo-pre-commit hook for automatic TOML formatting

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

Copy link
Contributor

sourcery-ai bot commented May 29, 2025

Reviewer's Guide

This PR restructures the project’s configuration by reorganizing and normalizing entries in pyproject.toml—reordering metadata, dependencies, classifiers, tool settings and scripts—and adds a new Taplo formatter hook to the pre-commit configuration.

File-Level Changes

Change Details Files
Reordered project metadata and dependency blocks
  • Moved build-system requires under build-backend
  • Relocated name, version, description, readme, requires-python, license, and maintainers sections
  • Reformatted classifiers and project.dependencies with consistent indentation and ordering
  • Reorganized optional-dependencies groups (jupyter, graphics, all, tests, doc)
pyproject.toml
Normalized project URLs and scripts entries
  • Reordered project.urls keys to Issues, Source, Tracker
  • Moved pymapdl_convert_script entry point below main script
pyproject.toml
Standardized tool configuration sections
  • Reordered pytest.ini_options, markers, and testpaths
  • Sorted and aligned isort, coverage, codespell, numpydoc, mypy, towncrier settings
  • Adjusted list formats and indentation across tool.* blocks
pyproject.toml
Added Taplo formatter to pre-commit
  • Added ComPWA/taplo-pre-commit repository
  • Configured taplo-format hook with reorder_arrays and reorder_keys options
.pre-commit-config.yaml

Assessment against linked issues

Issue Objective Addressed Explanation
#3968 Add taplo pre-commit hook to format and sort toml files.
#3968 Apply taplo to reformat and sort entries in pyproject.toml.

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

@github-actions github-actions bot added dependencies maintenance General maintenance of the repo (libraries, cicd, etc) enhancement Improve any current implemented feature labels May 29, 2025
Copy link

codecov bot commented May 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.26%. Comparing base (cce7ad1) to head (de5bfd5).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3971   +/-   ##
=======================================
  Coverage   88.25%   88.26%           
=======================================
  Files         187      187           
  Lines       14935    14935           
=======================================
+ Hits        13181    13182    +1     
+ Misses       1754     1753    -1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89
Copy link
Collaborator

germa89 commented May 30, 2025

@tkoyama010 thank you a lot for your PR!!

@pyansys-ci-bot LGTM.

@germa89 germa89 merged commit 194c0c6 into main May 30, 2025
50 checks passed
@germa89 germa89 deleted the migration/pr-3968 branch May 30, 2025 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies enhancement Improve any current implemented feature maintenance General maintenance of the repo (libraries, cicd, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants