ci: add check statuses to PRs from slash command execution#683
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the CI workflow to post check statuses on PRs when triggering via slash commands.
- Adds a step to post an "In Progress" (pending) status before tests run
- Adds a step to post a completion status when tests finish
Aaron ("AJ") Steers (aaronsteers)
merged commit 1b886e7
into
main
Aaron ("AJ") Steers (aaronsteers)
deleted the
aj/ci/let-slash-commands-post-pr-check-statuses
branch
📝 WalkthroughWalkthroughThe workflow for the on-demand PR pytest job was updated to explicitly post "Pending" and "Completed" check statuses to pull requests using the LouisBrunner/checks-action@v2.0.0 GitHub Action. These updates occur at the start and end of the test job, ensuring check statuses accurately reflect the job's progress and outcome. Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub PR
participant Workflow
participant Checks Action
GitHub PR->>Workflow: Trigger PR test job
Workflow->>Checks Action: Post "Pending" check status
Workflow->>Workflow: Run pytest and other test steps
Workflow->>Checks Action: Post "Completed" check status with result
Checks Action-->>GitHub PR: Update check status on PR
Possibly related PRs
Would you like to see a comparison diagram of the workflow before and after this change, wdyt? 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/workflows/test-pr-command.yml (1)
119-129: Align the “Completed” step naming for clarity?You’ve correctly added the completed status to close out the check run, but the step is named
Create Status Checkwhereas the pending step explicitly saysCreate "Pending" Check Status. Maybe renaming this toCreate "Completed" Check Statuswould make the workflow more symmetric and self-documenting—wdyt?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/test-pr-command.yml(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Pytest (All, Python 3.11, Windows)
- GitHub Check: Pytest (All, Python 3.10, Windows)
- GitHub Check: Pytest (No Creds)
- GitHub Check: Pytest (All, Python 3.11, Ubuntu)
- GitHub Check: Pytest (All, Python 3.10, Ubuntu)
- GitHub Check: Pytest (Fast)
🔇 Additional comments (1)
.github/workflows/test-pr-command.yml (1)
73-83: Great addition of a “Pending” check status!This step will surface an in-progress check run for each matrix job, so slash commands can properly reflect the test status on the PR. Could you double-check that using
status: in_progressyields the expected “pending” display in the GitHub UI? wdyt?Consider running a quick check on an example PR, or using the GitHub CLI to list check-runs for the commit, to ensure the new in-progress status shows up as intended.
Summary by CodeRabbit