Skip to content

Commit 4fb2baa

Browse files
committed
Add schedule triggers to workflows whenever possible
This repository contains several GitHub Actions workflows to facilitate the development and maintenance. The workflows are typically configured to run whenever any relevant file in the repository is changed. However, the results of the workflow run are also dependent on the external environment it runs in, which include: - The software running on the GitHub hosted GitHub Actions runner machines - The GitHub Actions actions used by the workflow - The dependencies that are installed by the workflow directly or via the GitHub Actions actions it uses The workflows often do not fully pin to a specific version of given external tool. This was done in the interest on reducing the maintenance burden of keeping the systems up to date. However, it also means that a new release can cause the workflow runs to start failing (which might happen through an enhancement to that resource resolving a false negative, or a defect causing a false negative). When the repository file path trigger is used by itself, this sort of external breakage is only revealed when an unrelated change triggers the workflow. That can be distracting even to a dedicated member of the project development team, as well as confusing and discouraging to any contributor. This type of change can be caught by adding a `schedule` event trigger that causes the workflow to run periodically in addition to the other on-demand triggers. This allows the problem to be identified and resolved at the maintainer's convenience, separate from the unrelated development work.
1 parent 5829764 commit 4fb2baa

7 files changed

+21
-0
lines changed

Diff for: .github/workflows/check-go-task.yml

+3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ on:
2222
- "**/go.mod"
2323
- "**/go.sum"
2424
- "**.go"
25+
schedule:
26+
# Run periodically to catch breakage caused by external changes.
27+
- cron: "0 7 * * WED"
2528
workflow_dispatch:
2629
repository_dispatch:
2730

Diff for: .github/workflows/check-license.yml

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

Diff for: .github/workflows/check-mkdocs-task.yml

+3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ on:
3232
- "docsgen/**"
3333
- "ruledocsgen/**"
3434
- "**.go"
35+
schedule:
36+
# Run periodically to catch breakage caused by external changes.
37+
- cron: "0 5 * * WED"
3538
workflow_dispatch:
3639
repository_dispatch:
3740

Diff for: .github/workflows/check-prettier-formatting-task.yml

+3
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,9 @@ on:
196196
- "**.rviz"
197197
- "**.sublime-syntax"
198198
- "**.syntax"
199+
schedule:
200+
# Run periodically to catch breakage caused by external changes.
201+
- cron: "0 4 * * WED"
199202
workflow_dispatch:
200203
repository_dispatch:
201204

Diff for: .github/workflows/check-python-task.yml

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ on:
2828
- "Taskfile.ya?ml"
2929
- "**/tox.ini"
3030
- "**.py"
31+
schedule:
32+
# Run periodically to catch breakage caused by external changes.
33+
- cron: "0 8 * * WED"
3134
workflow_dispatch:
3235
repository_dispatch:
3336

Diff for: .github/workflows/test-go-integration-task.yml

+3
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ on:
3030
- "poetry.lock"
3131
- "pyproject.toml"
3232
- "tests/**"
33+
schedule:
34+
# Run periodically to catch breakage caused by external changes.
35+
- cron: "0 10 * * WED"
3336
workflow_dispatch:
3437
repository_dispatch:
3538

Diff for: .github/workflows/test-go-task.yml

+3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ on:
2626
- "Taskfile.ya?ml"
2727
- "**.go"
2828
- "**/testdata/**"
29+
schedule:
30+
# Run periodically to catch breakage caused by external changes.
31+
- cron: "0 11 * * WED"
2932
workflow_dispatch:
3033
repository_dispatch:
3134

0 commit comments

Comments
 (0)