docs: (ci) - skip checking broken links on push to main#504
docs: (ci) - skip checking broken links on push to main#504talos-bot merged 1 commit intosiderolabs:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Docs CI GitHub Actions workflow to stop running on push events to main, relying on PR-time checks instead.
Changes:
- Removed the
push: branches: [main]trigger from.github/workflows/docs-ci.yaml.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| on: | ||
| pull_request: | ||
| paths: | ||
| - "public/**" | ||
| - "omni/**" | ||
| - "talos/**" | ||
| - "**/*.md" | ||
| - "**/*.mdx" | ||
| - "Makefile" |
There was a problem hiding this comment.
With push removed, this workflow will no longer run post-merge for changes that don’t match the pull_request.paths filter. In particular, repo contains docs-gen/** (the docs.json generator) and changes there wouldn’t trigger this workflow on PR, and now also won’t get a post-merge run on main, which can let make docs.json drift or make broken-links regressions land undetected. Consider either (a) adding additional paths like docs-gen/** (and any other inputs to make docs.json / make broken-links, e.g. go.mod/go.sum if applicable) to the PR path filter, or (b) restoring a push: branches: [main] trigger and conditionally skipping only the broken-link step on pushes.
|
/m |
There's no need to re-run broken link checks on merge. Signed-off-by: Noel Georgi <git@frezbo.dev>
41f3515 to
cc64248
Compare
|
/m |
There's no need to re-run broken link checks on merge.