Skip to content

More workflow and documentation improvements#611

Merged
knoepfel merged 4 commits into
mainfrom
maintenance/more-workflow-improvements
May 21, 2026
Merged

More workflow and documentation improvements#611
knoepfel merged 4 commits into
mainfrom
maintenance/more-workflow-improvements

Conversation

@greenc-FNAL
Copy link
Copy Markdown
Contributor

@greenc-FNAL greenc-FNAL commented May 20, 2026

Fix yaml-check.yaml consistency and portability of tidy-check trigger

  • yaml-check.yaml: replace actions/setup-python+pip with astral-sh/setup-uv
    and uv tool install, consistent with all other Python-tool workflows
  • yaml-check.yaml: add pull-requests: read permission (needed by workflow- setup action for get-pr-info)
  • clang-tidy-check.yaml: replace hardcoded '@phlexbot tidy-check' literal
    with format expression for portability across repository forks

Fix remaining CI audit issues and update documentation

Code fixes

  • handle-fix-commit: update upload-artifact from v6.0.0 to v7.0.1
  • post-clang-tidy-results: update download-artifact from v8.0.0 to v8.0.1
  • post-clang-tidy-results: use context.repo.repo for bot name in JS
    comment (replaces hardcoded @phlexbot with repo-name-derived value)
  • yaml-check: add workflow_call trigger with standard check-workflow
    inputs; pass inputs through to workflow-setup action
  • clang-format-check: add workflow_call trigger with standard inputs;
    pass inputs through to workflow-setup action

Documentation

  • CLANG_TIDY_CONFIGURATION.md: update GitHub Actions Workflows section
    to reflect workflow_run pattern for fork PR comment posting; add
    clang-tidy-report.yaml section explaining why it exists and how it
    works
  • DEVELOPING.md: correct coverage CI trigger description (main and
    release/* branches, not main/develop); clarify that prek is
    pre-installed in the devcontainer; fix typo in pre-commit section
  • REUSABLE_WORKFLOWS.md: fix @phlexbot bot-command notation (was an
    unrendered GitHub Actions expression literal); add sections 16-18 for
    clang-format-check, header-guards-check, and yaml-check (all now
    available via workflow_call); expand 'Other Workflows' section to
    enumerate all non-reusable internal workflows

- yaml-check.yaml: replace actions/setup-python+pip with astral-sh/setup-uv
  and uv tool install, consistent with all other Python-tool workflows
- yaml-check.yaml: add pull-requests: read permission (needed by workflow-
  setup action for get-pr-info)
- clang-tidy-check.yaml: replace hardcoded '@phlexbot tidy-check' literal
  with format expression for portability across repository forks
Code fixes:
- handle-fix-commit: update upload-artifact from v6.0.0 to v7.0.1
- post-clang-tidy-results: update download-artifact from v8.0.0 to v8.0.1
- post-clang-tidy-results: use context.repo.repo for bot name in JS
  comment (replaces hardcoded @phlexbot with repo-name-derived value)
- yaml-check: add workflow_call trigger with standard check-workflow
  inputs; pass inputs through to workflow-setup action
- clang-format-check: add workflow_call trigger with standard inputs;
  pass inputs through to workflow-setup action

Documentation:
- CLANG_TIDY_CONFIGURATION.md: update GitHub Actions Workflows section
  to reflect workflow_run pattern for fork PR comment posting; add
  clang-tidy-report.yaml section explaining why it exists and how it
  works
- DEVELOPING.md: correct coverage CI trigger description (main and
  release/* branches, not main/develop); clarify that prek is
  pre-installed in the devcontainer; fix typo in pre-commit section
- REUSABLE_WORKFLOWS.md: fix @phlexbot bot-command notation (was an
  unrendered GitHub Actions expression literal); add sections 16-18 for
  clang-format-check, header-guards-check, and yaml-check (all now
  available via workflow_call); expand 'Other Workflows' section to
  enumerate all non-reusable internal workflows
Copilot AI review requested due to automatic review settings May 20, 2026 22:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates project documentation and GitHub Actions workflows to improve CI behavior and make workflow usage clearer, especially around reusable workflows and bot-triggered commands.

Changes:

  • Update developer documentation for coverage and pre-commit usage.
  • Extend several CI workflows (YAML / clang-format) to support workflow_call inputs and switch YAML lint setup to uv.
  • Refine clang-tidy/bot messaging and update pinned GitHub Action SHAs.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
DEVELOPING.md Updates CI coverage branch description and clarifies pre-commit setup (devcontainer vs local).
CLANG_TIDY_CONFIGURATION.md Expands workflow trigger/behavior documentation for clang-tidy and introduces a described report workflow.
.github/workflows/yaml-check.yaml Adds workflow_call support and installs yamllint via uv.
.github/workflows/clang-tidy-check.yaml Makes the tidy-check comment trigger bot-name dynamic based on repository name.
.github/workflows/clang-format-check.yaml Adds workflow_call support and relevance-skip input handling.
.github/REUSABLE_WORKFLOWS.md Documents new reusable workflow inputs and updates bot-trigger guidance.
.github/actions/post-clang-tidy-results/action.yaml Updates artifact download pin and makes the tidy-fix hint use the repo-derived bot name.
.github/actions/handle-fix-commit/action.yaml Updates the pinned actions/upload-artifact SHA.
Comments suppressed due to low confidence (1)

DEVELOPING.md:143

  • The section says developers can install either pre-commit or prek, but the follow-up commands only mention pre-commit (pre-commit install, pre-commit run --all-files). If a contributor installs only prek, these commands will fail. Consider documenting both invocations (e.g., “run pre-commit install (or prek install)” and similarly for run).
In the devcontainer, `prek` (a faster Rust re-implementation of `pre-commit`) is already installed and the hooks are configured automatically. No manual setup is needed in that environment.

Outside the devcontainer, install `pre-commit` or `prek` using your system package manager or `uv`/`pip(x)`, e.g. `uv tool install pre-commit`.

To set up the hooks in the Phlex repository, run the `pre-commit install` command once in the repository. The hooks now should run automatically prior to each commit.

To skip a check temporarily, run `SKIP=ruff-format git commit -m "..."`. To skip all hooks, you can use the `--no-verify` flag to `git commit`.

To manually run hooks over all files, run `pre-commit run --all-files`.

Comment thread CLANG_TIDY_CONFIGURATION.md
Comment thread .github/REUSABLE_WORKFLOWS.md
Agent-Logs-Url: https://github.com/Framework-R-D/phlex/sessions/c3311079-6137-4677-be7b-83fdb931bbab

Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>
@greenc-FNAL
Copy link
Copy Markdown
Contributor Author

@copilot My comments #611 (comment) and #611 (comment) were intended to convey that there is a reason that the documentation was out of step with the code, and that this was intentional, and assumed that #610 would be merged first. Please revert/remove c9d10ba, and resolve the review comment conversations with a note that the discrepancies are intentional and temporary.

The documentation intentionally describes the workflow structure that will
exist after PR #610 merges. The discrepancy with the current code is
temporary and expected.

Agent-Logs-Url: https://github.com/Framework-R-D/phlex/sessions/b95582cc-94b1-4e09-b24a-19f82491a8cb

Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented May 20, 2026

@copilot My comments #611 (comment) and #611 (comment) were intended to convey that ther...

Reverted in 750df7f. The documentation now describes the workflow structure that will exist after PR #610 merges, with the understanding that the current discrepancy with the code is intentional and temporary.

@knoepfel knoepfel merged commit 1b6b94e into main May 21, 2026
38 checks passed
@knoepfel knoepfel deleted the maintenance/more-workflow-improvements branch May 21, 2026 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants