[DOC]: Mention skip-tests
convention for commits that should not trigger CI in ci-overview
#277
Closed
1 task done
Labels
needs triage
Issues that require the team's attention
Is this a duplicate?
Is this for new documentation, or an update to existing docs?
Update
Describe the incorrect/future/missing documentation
As seen in discussion in #274, if a PR only updates the docs, it is recommended to add
[skip-tests]
to the commit message to avoid running CI on a change that doesn't need it (modulo perhaps building the docs to check nothing is broken?). However, this is not a discoverable feature for a casual contributor (it's only by reading the dispatch workflow that you can determine how this works).Aside, one might be able to take advantage of either workflow-level path skipping, or else a third-party workflow to job level path filter to automate skipping of expensive CI for docs only changes.
If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.
No response
The text was updated successfully, but these errors were encountered: