Skip to content

Use standard position for non-configuration env mapping in workflow #169

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

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 4, 2025

In cases where some project-specific configuration of reusable GitHub Actions workflows must be done via workflow environment variables, the standard practice is to place the global env mapping near the top of the workflow to make them easily accessible to the project maintainer. However, in other cases the mapping does not contain any values that require adjustment. In this case, the established practice is to place it after the on mapping.

Previously, the env mapping of the "Sync Labels" workflow was used to define the project's standard Node.js version, and thus the mapping was placed at the top of the workflow. However, this configuration was obviated by the change to defining the Node.js value in the package.json file (#124). So the env mapping is no longer used for per-project configuration in this workflow and thus it should be moved below the on mapping.

In cases where some project-specific configuration of reusable GitHub Actions workflows must be done via workflow
environment variables, the standard practice is to place the global `env` mapping near the top of the workflow to make
them easily accessible to the project maintainer. However, in other cases the mapping does not contain any values that
require adjustment. In this case, the established practice is to place it after the `on` mapping.

Previously, the `env` mapping of the "Sync Labels" workflow was used to define the project's standard Node.js version,
and thus the mapping was placed at the top of the workflow. However, this configuration was obviated by the change to
defining the Node.js value in the `package.json` file. So the `env` mapping is no longer used for per-project
configuration in this workflow and thus it should be moved below the `on` mapping.
@per1234 per1234 self-assigned this Jun 4, 2025
@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure labels Jun 4, 2025
@per1234 per1234 merged commit 8af4d63 into arduino:master Jun 4, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant