Skip to content

ci: update status when action triggered by issue comment - #248

Merged
richm merged 1 commit into
mainfrom
checks-update-pr-status
Sep 4, 2026
Merged

ci: update status when action triggered by issue comment#248
richm merged 1 commit into
mainfrom
checks-update-pr-status

Conversation

@richm

@richm richm commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

issue comment triggers do not automatically update check status in the PR, so
use separate steps to update them, similar to how the tft.yml workflow works.
For issue comment workflows, ensure that the head_sha is set early in the
workflow and the status is only updated if there is a head_sha.

Create a variable for context so it is created in one place and used in several
places in the workflow.

Ensure that the first steps in the workflow are to get the head_sha and set the
status to In Progress.

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by CodeRabbit

  • New Features
    • Added commit status reporting for workflow runs triggered by pull request comments.
    • Workflows now show pending status before checks begin and success or failure status when they finish.
    • Statuses are associated with the correct pull request commit, including matrix-based test scenarios.

@richm
richm requested a review from spetrosi as a code owner September 4, 2026 00:03
@richm richm self-assigned this Sep 4, 2026
issue comment triggers do not automatically update check status in the PR, so
use separate steps to update them, similar to how the tft.yml workflow works.
For issue comment workflows, ensure that the head_sha is set early in the
workflow and the status is only updated if there is a head_sha.

Create a variable for context so it is created in one place and used in several
places in the workflow.

Ensure that the first steps in the workflow are to get the head_sha and set the
status to In Progress.

Signed-off-by: Rich Megginson <rmeggins@redhat.com>
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 00425538-f0ef-4b8b-88fa-9e6bb3937c13

📥 Commits

Reviewing files that changed from the base of the PR and between f819dce and 89289c6.

📒 Files selected for processing (11)
  • .github/workflows/ansible-lint.yml
  • .github/workflows/ansible-managed-var-comment.yml
  • .github/workflows/ansible-test.yml
  • .github/workflows/codeql.yml
  • .github/workflows/codespell.yml
  • .github/workflows/markdownlint.yml
  • .github/workflows/python-unit-test.yml
  • .github/workflows/qemu-kvm-integration-tests.yml
  • .github/workflows/test_converting_readme.yml
  • .github/workflows/tft.yml
  • .github/workflows/woke.yml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

GitHub Actions workflows now resolve pull request head commits for issue-comment runs, set pending commit statuses before execution, and report final job results afterward. The Testing Farm workflow centralizes status SHA and context outputs.

Changes

Commit status lifecycle

Layer / File(s) Summary
Resolve heads and set pending statuses
.github/workflows/ansible-lint.yml, .github/workflows/ansible-managed-var-comment.yml, .github/workflows/ansible-test.yml, .github/workflows/codeql.yml, .github/workflows/codespell.yml, .github/workflows/markdownlint.yml, .github/workflows/python-unit-test.yml, .github/workflows/qemu-kvm-integration-tests.yml, .github/workflows/test_converting_readme.yml, .github/workflows/woke.yml
The workflows add statuses: write, emit head SHA and context outputs, set pending statuses, and check out the resolved head commit.
Report final workflow status
.github/workflows/ansible-lint.yml, .github/workflows/ansible-managed-var-comment.yml, .github/workflows/ansible-test.yml, .github/workflows/codeql.yml, .github/workflows/codespell.yml, .github/workflows/markdownlint.yml, .github/workflows/python-unit-test.yml, .github/workflows/qemu-kvm-integration-tests.yml, .github/workflows/test_converting_readme.yml, .github/workflows/woke.yml
The workflows publish final commit statuses after execution, including failed jobs and skipped platform cases where applicable.
Testing Farm status output wiring
.github/workflows/tft.yml
The workflow centralizes head SHA and matrix context outputs, adds a github.sha fallback, and uses the outputs for pending, skipped, and final statuses.

Merge Risk: ⚪ Minimal · up to 89289

Issue-comment-triggered workflows now publish pending and final statuses against resolved pull-request head commits. The supplied workflow review found no current merge-blocking risk.

🚥 Pre-merge checks | ✅ 5 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description Format ⚠️ Warning The PR description does not follow the required section format. The repository template defines Enhancement:, Reason:, and Result: sections, and this change is a bug fix because it addresses mis… Rewrite the PR description using the bug-fix template. Include labeled Cause:, Consequences:, Fix:, and Result: sections that describe this workflow-status issue and its resolution. Keep `Signed-off-by: Rich Megginson <rmeggins@redh…
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows Conventional Commits format with the valid type "ci" and accurately describes the workflow status changes for issue-comment-triggered actions.
Description check ✅ Passed The description clearly explains the reason, result, and implementation objectives. It does not use the required template headings and does not explicitly state whether Jira or BZ tickets apply, but t…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description clearly explains the reason, result, and implementation objectives. It does not use the required template headings and does not explicitly state whether Jira or BZ tickets apply, but the content is otherwise complete and relevant.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (11 skipped: 11 unsupported.)

Full details: Description Format

Explanation

The PR description does not follow the required section format. The repository template defines Enhancement:, Reason:, and Result: sections, and this change is a bug fix because it addresses missing PR status updates for issue-comment workflows. The bug-fix format therefore requires Cause:, Consequences:, Fix:, and Result: sections. The description contains none of these labeled sections. It does contain a valid Signed-off-by: line with a name and email address.

Resolution

Rewrite the PR description using the bug-fix template. Include labeled Cause:, Consequences:, Fix:, and Result: sections that describe this workflow-status issue and its resolution. Keep Signed-off-by: Rich Megginson &lt;rmeggins@redhat.com&gt;. Add Issue Tracker Tickets (Jira or BZ if any): and Assisted-by: only if applicable.

  • Fix all pre-merge checks with AI

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@richm
richm merged commit ecd2c39 into main Sep 4, 2026
15 checks passed
@richm
richm deleted the checks-update-pr-status branch September 4, 2026 13:23
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.

1 participant