Skip to content

[Github][Docs] Add testing best practices to CI Best Practices Doc #172235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
boomanaiden154 merged 1 commit into from
Dec 15, 2025
+18 −0
Merged

[Github][Docs] Add testing best practices to CI Best Practices Doc #172235

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions llvm/docs/CIBestPractices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,24 @@ branches as follows:
- main
- release/*

Make Workflows Run on Updates to the Workflow Definition
--------------------------------------------------------

Whenever possible, workflows should also run whenever the workflow definition
is updated. This enables easily testing the workflow whenever modifying it. For
example, if we have a workflow with a definition in ``.github/workflows/foo.yaml``,
we should have at least the following event within the workflow:

.. code-block:: yaml

pull_request:
paths:
- .github/workflows/foo.yaml

Note that it is not always possible to enable this (e.g., issues that use a
``workflow_run`` trigger). But when possible, this makes testing the workflow
much simpler.

Container Best Practices
========================

Expand Down
Loading