Skip to content

Add template for checking Poetry configuration files #609

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 3 commits into from
Jun 20, 2025

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 20, 2025

Project Python package dependencies are managed using the Poetry tool.

Tasks and a GitHub Actions workflow are added to maintain and check for problems in the Poetry configuration files.

The tasks provide the following operations:

  • Check for problems with the data structure of the pyproject.toml Python project file
  • Update the poetry.lock file as may be required following manual modifications to pyproject.toml, or update of the Poetry application

These tasks are executed by the GitHub Actions workflow on any push or pull request that modifies relevant files, and periodically to check for breakage caused by external changes.

Related

per1234 added 3 commits June 20, 2025 00:04
…ncies` table

Originally Poetry supported two distinct dependency types, each defined separately in the `pyproject.toml` file:

* main: defined under the `tool.poetry.dependencies` table
* dev: defined under the `tool.poetry.dev-dependencies` table

This concept of dependency types was later made more flexible by allowing the user to define any number of arbitrary
dependency "groups", with "dev" simply being one of those groups. A new table naming scheme was created to support this
flexible dependency groups system.

For the sake of backwards compatibility, Poetry does still support use of the `tool.poetry.dev-dependencies` table.
However, it is deprecated and its use results in a warning.

The project's Poetry configuration is hereby migrated to the modern format.
Project Python package dependencies are managed using the "Poetry" tool.

Tasks and a GitHub Actions workflow are added to maintain and check for problems in the Poetry configuration files.

The tasks provide the following operations:

* Check for problems with the data structure of the `pyproject.toml` Python project file
* Update the `poetry.lock` file as may be required following manual modifications to `pyproject.toml`, or update of the
  "Poetry" application

These tasks are executed by the GitHub Actions workflow on any push or pull request that modifies relevant files, and
periodically to check for breakage caused by external changes.
@per1234 per1234 self-assigned this Jun 20, 2025
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Jun 20, 2025
@per1234 per1234 merged commit 5b0e954 into arduino:main Jun 20, 2025
51 checks passed
@per1234 per1234 changed the title Add templates for checking Poetry configuration files Add template for checking Poetry configuration files Jun 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant