Sync license check CI workflow with template #220
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #220 +/- ##
=======================================
Coverage 87.97% 87.97%
=======================================
Files 43 43
Lines 4176 4176
=======================================
Hits 3674 3674
Misses 391 391
Partials 111 111
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
silvanocerza
approved these changes
Aug 2, 2021
This is the naming convention established in the standardized template workflow. Even though it was never realized, the original idea was for the scope of this workflow to be for linting of the repository's documentation files. However, that approach leads to inefficient workflow trigger path filters. The better approach is to scope workflows to a file type. So it is more appropriate to scope the workflow to any checks specific to the license, and the workflow name should reflect that purpose.
This is the template workflow filename, which is intended to serve as a unique identifier, and thus should be used by all deployments of the template.
Task provides a convenient way to run common development processes locally with a single command. But I don't think the need to check the license file is common, nor something anyone would bother running. Instead, it's something that can be added to the repository and forgotten until the day comes that someone mucks around with the license file. That person likely would not have been aware of the existence of the task.
The license detection system is case insensitive, so the workflow should be also.
…h trigger These have lower priority, but they are recognized and so should be covered in order for the check to be completely comprehensive.
The `workflow_dispatch` event allows triggering the workflow via the GitHub web interface. This makes it easy to trigger an immediate workflow run after some relevant external change. The `repository_dispatch` event allows triggering workflows via the GitHub API. This might be useful for triggering an immediate check in multiple relevant repositories after an external change, or some automated process. Although we don't have any specific need for this event at the moment, the event has no impact on the workflow, so there is no reason against having it. It is the sort of thing that can end up being useful if it is already in consistently in place, but not worth setting up on demand, since the effort to set it up is greater than the effort to trigger all the workflows manually.
These are the naming conventions established in the standardized template workflow.
This might provide some additional useful information to the reader in the event of a failure.
The use of the `error` workflow command will cause the important error message output to be surfaced prominently in the workflow run summary and log. The workflow run logs can be somewhat labyrinthine to those who don't work with them regularly, so finding the previous output to determine what caused the failure might have been challenging.
Although very useful information, it doesn't apply directly to the licensee commands being run in this workflow step, and thus might be confusing.
This will make it easier for the maintainers to sync fixes and improvements in either direction between the upstream "template" workflow and its installation in this repository.
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 GitHub Actions workflows:
https://github.com/arduino/tooling-project-assets
These workflows will be used in the repositories of all Arduino tooling projects.
Some minor improvements and standardizations have been made in the upstream "template" workflow, and those are introduced to this repository via this pull request.