Skip to content

Use task to install Python package dependencies in website deployment workflows #602

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 2 commits into from
Jun 19, 2025

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 19, 2025

The Task task runner tool is used to perform common development and maintenance operations in Arduino tooling projects.

One such operation is the installation of Python package dependencies using Poetry. The project website deployment workflows rely on Python packages, and so contain a step to install them. Previously, this was done by invoking the Poetry command directly from the workflow. That is problematic because it means multiple copies of the command must be maintained, and the maintainer might easily overlook the need to do so for these workflows since we expect there to be only one instance of the command.

The workflows are hereby changed to use the standardized approach to installing Python package dependencies.

per1234 added 2 commits June 18, 2025 11:11
Some GitHub Actions workflows must install the appropriate version of Go and Python. Previously the version was
configured in the workflow, and so the template installation documentation included instructions for setting the
project's version of the framework in the workflow.

A new approach is now used to get Go and Python versioning information from a single source in the configuration file,
so there is no longer any version configuration in the workflow, rendering those instructions obsolete. The instructions
were not removed at the time the workflows were migrated to the new system.
… workflows

The "Task" task runner is used to perform common development and maintenance operations in Arduino tooling projects.

One such operation is the installation of Python package dependencies using Poetry. The project website deployment
workflows rely on Python packages, and so contain a step to install them. Previously, this was done by invoking the
Poetry command directly from the workflow. That is problematic because it means multiple copies of the command must be
maintained, and the maintainer might easily overlook the need to do so for these workflows since we expect there to be
only one instance of the command.

The workflows are hereby changed to use the standardized approach to installing Python package dependencies.
@per1234 per1234 self-assigned this Jun 19, 2025
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: code Related to content of the project itself labels Jun 19, 2025
@per1234 per1234 merged commit a478861 into arduino:main Jun 19, 2025
19 checks passed
@per1234 per1234 deleted the use-poetry_install-deps-task branch June 19, 2025 14:54
@per1234 per1234 changed the title Remove obsolete instructions re: setting framework versions in workflows Use task to install Python package dependencies in website deployment workflows Jun 19, 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: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant