Skip to content

Commit 74bb001

Browse files
committed
Add schedule event triggers to GitHub Actions workflows
GitHub Actions workflows used to validate project content are configured to be triggered by any push or pull request that modifies relevant files. These workflows rely on external resources such as the GitHub Actions infrastructure, GitHub Actions actions, dependencies. Inevitably, breaking changes will occur in these resources, requiring adaptation of the project infrastructure to fix. If the workflow is only configured to run on changes to project files, breakage caused by external changes will only be revealed by contributor activity. This results in confusion for the contributor who will assume the failing workflow run was caused by the change they made. This results in inconvenience for the maintainer who must explain the situation to the contributor and do without the benefit of the automated validation of the contribution. For this reason, it is best practices to always configure such GitHub Actions workflows to also be triggered on a schedule. This allows breakage to be detected and resolved before it impacts contributions.
1 parent 18c6507 commit 74bb001

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

.github/workflows/check-license.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ on:
2525
- "[lL][iI][cC][eE][nN][cCsS][eE]*"
2626
- "[oO][fF][lL]*"
2727
- "[pP][aA][tT][eE][nN][tT][sS]*"
28+
schedule:
29+
# Run periodically to catch breakage caused by external changes.
30+
- cron: "0 6 * * WED"
2831
workflow_dispatch:
2932
repository_dispatch:
3033

.github/workflows/check-prettier-formatting-task.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ on:
195195
- "**.rviz"
196196
- "**.sublime-syntax"
197197
- "**.syntax"
198+
schedule:
199+
# Run periodically to catch breakage caused by external changes.
200+
- cron: "0 4 * * WED"
198201
workflow_dispatch:
199202
repository_dispatch:
200203

.github/workflows/check-yaml-task.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ on:
3939
- "**.rviz"
4040
- "**.sublime-syntax"
4141
- "**.syntax"
42+
schedule:
43+
# Run periodically to catch breakage caused by external changes.
44+
- cron: "0 9 * * WED"
4245
workflow_dispatch:
4346
repository_dispatch:
4447

0 commit comments

Comments
 (0)