Skip to content

Commit

Permalink
Add missing schedule triggers to workflows (#252)
Browse files Browse the repository at this point in the history
This repository contains several GitHub Actions workflows to facilitate the development and maintenance of the project.

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 don't always fully pin dependencies. 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 of a dependency 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.
  • Loading branch information
per1234 authored Oct 11, 2024
1 parent 66ff1ba commit e3bd9e4
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/check-mkdocs-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ on:
- "docs/**"
- "docsgen/**"
- "**.go"
schedule:
# Run periodically to catch breakage caused by external changes.
- cron: "0 5 * * WED"
workflow_dispatch:
repository_dispatch:

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/check-prettier-formatting-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,9 @@ on:
- "**.rviz"
- "**.sublime-syntax"
- "**.syntax"
schedule:
# Run periodically to catch breakage caused by external changes.
- cron: "0 4 * * WED"
workflow_dispatch:
repository_dispatch:

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/test-go-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ on:
- "Taskfile.ya?ml"
- "**.go"
- "**/testdata/**"
schedule:
# Run periodically to catch breakage caused by external changes.
- cron: "0 11 * * WED"
workflow_dispatch:
repository_dispatch:

Expand Down

0 comments on commit e3bd9e4

Please sign in to comment.