A collection of reusable GitHub Actions workflows.
While some workflows can be added to any repository without any modification, others need to be configured for each project. "TODO" comments in the workflow explain what needs to be done and TODO_* placeholders indicate where project-specific information needs to be filled in. Documentation for each workflow is provided by the .md file of the same name, including:
- Instructions
- List of asset files which must be added to the repository along with the workflow
- Markup for status badges that can be added to the readme
- Stock commit messages
Whenever possible, these workflows should be used as the models when setting up GitHub Actions in a repository, rather than sourcing equivalent, possibly outdated, workflows from a random repository. If fixes or improvements are discovered, please push them back here to the workflow templates, from whence they can propagate to all other repositories.
Addition of, or requests for, any additional workflows that can be reusable between several of the Arduino Tooling Team's repositories are welcome.
Note: GitHub Actions periodically has outages which result in workflow failures unrelated to any problems with the contents of the repository or actions used by the workflow. In this event, the workflows will start passing again once the service recovers.
Dependabot is used to check for outdated action versions used in the template workflows.
Dependabot's PRs will occasionally try to pin to the patch version of the action (e.g., updating uses: foo/bar@v1 to uses: foo/[email protected]). When the action author has provided a major version ref, use that instead (e.g., uses: foo/bar@v2). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump.
The same can be done for the workflows of any repository. See the instructions here.