You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Modernize Markdown workflows and update documentation
- Updated `markdown-check.yaml` and `markdown-fix.yaml` for consistency with
other repository workflows (e.g., `cmake-format-check`).
- Added robust `workflow_call` support with standard inputs.
- Implemented trigger type emulation in `markdown-check.yaml` to intelligently
handle relevance checks for automatic vs. manual callers.
- Standardized job naming, checkout paths, and dynamic bot command logic.
- Updated `REUSABLE_WORKFLOWS.md` with comprehensive documentation for
markdown check/fix workflows and fixed pre-existing linting issues.
Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>
Copy file name to clipboardExpand all lines: .github/REUSABLE_WORKFLOWS.md
+29-8Lines changed: 29 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,18 +12,18 @@ Additionally, you can configure your own fork of Phlex to run CI checks on local
12
12
13
13
If you are a Phlex-affiliated developer working on a dependent package of Phlex, or on a different Cetmodules-using package, or on Cetmodules itself, you may be able to invoke these workflows on your own project following the information in this guide. However, this is only supported for Phlex-affiliated developers, and even then on a best effort basis. We do **not** support or encourage others to utilize these workflows at this time.
Most workflows in this repository can be run manually on any branch, tag, or commit. This is useful for testing changes without creating a pull request or for applying fixes to a specific branch.
18
18
19
19
To run a workflow manually:
20
20
21
-
1.Navigate to the **Actions** tab of the Phlex repository (or your fork).
22
-
1.In the left sidebar, click the workflow you want to run (e.g., **Clang-Format Check**).
23
-
1.Above the list of workflow runs, you will see a banner that says "This workflow has a `workflow_dispatch` event trigger." Click the **Run workflow** dropdown on the right.
24
-
1.Use the **Branch/tag** dropdown to select the branch you want to run the workflow on.
25
-
1.Some workflows have additional inputs (e.g., the `cmake-build` workflow allows you to specify build combinations). Fill these out as needed.
26
-
1.Click the **Run workflow** button.
21
+
1. Navigate to the **Actions** tab of the Phlex repository (or your fork).
22
+
1. In the left sidebar, click the workflow you want to run (e.g., **Clang-Format Check**).
23
+
1. Above the list of workflow runs, you will see a banner that says "This workflow has a `workflow_dispatch` event trigger." Click the **Run workflow** dropdown on the right.
24
+
1. Use the **Branch/tag** dropdown to select the branch you want to run the workflow on.
25
+
1. Some workflows have additional inputs (e.g., the `cmake-build` workflow allows you to specify build combinations). Fill these out as needed.
26
+
1. Click the **Run workflow** button.
27
27
28
28
### For Contributors Working on a Fork of Phlex
29
29
@@ -185,6 +185,27 @@ Automatically formats Markdown files using `markdownlint` and commits the change
185
185
- `ref` (string, **required**): The branch or ref to check out.
186
186
- `repo` (string, **required**): The repository to check out from.
187
187
188
+
### 6. `markdown-check.yaml`
189
+
190
+
Checks Markdown files for formatting issues using `markdownlint`.
- `checkout-path` (string, optional): Path to check out code to.
203
+
- `skip-relevance-check` (boolean, optional, default: `false`): Bypass the check that only runs if Markdown files have changed. Note that this workflow automatically emulates the trigger type of the caller; it will run relevance checks if called from a `pull_request` or `push` event, and skip them (running on all files) otherwise.
204
+
- `pr-base-sha` (string, optional): Base SHA of the PR for relevance check.
205
+
- `pr-head-sha` (string, optional): Head SHA of the PR for relevance check.
206
+
- `ref` (string, optional): The branch, ref, or SHA to checkout.
207
+
- `repo` (string, optional): The repository to checkout from.
208
+
188
209
### Other Workflows
189
210
190
-
The repository also provides `actionlint-check.yaml`, `cmake-format-check.yaml`, `markdown-check.yaml`, and `codeql-analysis.yaml`, which can be used in a similar manner.
211
+
The repository also provides `actionlint-check.yaml`, `cmake-format-check.yaml`, and `codeql-analysis.yaml`, which can be used in a similar manner.
0 commit comments