Bring test workflow into compliance with best practices #42
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
per1234
added
type: enhancement
umbynos
approved these changes
May 10, 2021
"setup-taskflile" was an artifact of the project's previous home in the `arduino/actions` repo, which hosts multiple actions. In that case, it made some sense to have a single monolithic workflow for each project, named after the project. Now that the action has a dedicated repository. It is more useful to name the workflows according to their intended purpose.
Previously, tests were only run on Ubuntu and Windows.
Use of the major version ref will cause the workflow to use stable release versions of the utility actions while automatically benefiting from ongoing development to those actions up until such time as a new major release of an action is made. At that time we would need to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before updating the major ref (e.g., `uses: actions/checkout@v2` -> `uses: actions/checkout@v3`).
The `version` input name previously in use has been deprecated in favor of `node-version` and is no longer supported: https://github.com/actions/setup-node/blob/v2.1.5/action.yml#L27
Node.js 12 is the newest version available for the JavaScript GitHub Actions actions, and is the one in use, as specified in action.yml's `runs.using` key. So it is best to use the same when running the tests in the CI workflow.
The "Test TypeScript" workflow should only run when relevant files are modified.
The `workflow_dispatch` event trigger allows the workflow to be run manually via the GitHub web interface. This can be useful to trigger the workflow run in cases where the standard triggers won't, such as testing how external changes (e.g., actions used in the workflow) affected it. The `repository_dispatch` event serves a similar purpose, except triggered via the GitHub API.
The default behavior is to cancel all the other matrix jobs if one fails. However, it can often be valuable to see what the results are of the other jobs. In this case where the matrix is operating systems, it can be useful to see whether the problem is specific to one OS, or if it affects all.
Copy/paste error.
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.
actions/setup-nodeAPI