Make general adjustments to project infrastructure for sync with "template" assets #64
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These are the "template" workflow filenames, which are intended to serve as a unique identifier within a collection that might include multiple related variants, and thus must be a bit more verbose.
Placement of this information at the top of the GitHub Actions workflow files, where it is easy to find and edit, facilitates updates to the workflows as the tool versions used for project development are bumped periodically.
There are two file extensions in common use for YAML files: `.yaml` and `.yml`. Although this project uses `.yml` exclusively for YAML files, this is a standardized workflow which might be applied to projects that have established the use of the other extension. It will be most flexible if it supports both.
This is the naming convention established in the standardized template workflow. The tool name is "Task", with "taskfile" being its configuration file, so the previous step name was inaccurate.
This will make it easier for the maintainers to sync fixes and improvements in either direction between the upstream "template" assets and their installation in this repository.
These are the conventions established in the standardized "template" tasks.
A dedicated task has been added for installing the project's Python dependencies via Poetry, and this should be used throughout the taskfile in place of redundant direct commands.
per1234
added
type: enhancement
umbynos
approved these changes
Aug 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These will be used in the repositories of all Arduino tooling projects.
Some minor improvements and standardizations have been made in the upstream "template" assets, and this pull request introduces the minor global changes to the GitHub Actions workflow and taskfile. These changes should have no functional effect.
It will be followed by dedicated pull requests for the more significant and asset-specific changes.