-
Notifications
You must be signed in to change notification settings - Fork 45
Document CommitStatus structure in context variables #823
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
MishaKav
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lg
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✨ PR Review
The PR adds clear documentation for the CommitStatus structure, which improves the context variables reference. However, there's an inconsistency in the example that should be corrected.
1 issues detected:
🧾 Readability - The example data contains logically inconsistent values that don't represent a realistic commit status. 🛠️
Details: The example shows a commit status with state "pending" but description "The build succeeded!" which is contradictory. A pending state should not indicate success, as this could mislead users about what valid data looks like.
File:docs/context-variables.md (388-388)
🛠️ A suggested code correction is included in the review comments.
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Review using Guidelines Learn how
| ```json | ||
| [ | ||
| { | ||
| "state": "pending", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧾 Readability - Inconsistent Example: Change either the state to "success" to match the description, or change the description to something like "Build in progress..." to match the pending state.
| "state": "pending", | |
| "state": "success", |
Is this review accurate? Use 👍 or 👎 to rate it
If you want to tell us more, use /gs feedback e.g. /gs feedback this review doesn't make sense, I disagree, and it keeps repeating over and over
✨ PR Description
Purpose: Add documentation for the
CommitStatusstructure in gitStream's context variables to enable integration with external CI systems.Main changes:
pr.commit_statusesfield to the context variables table with GitHub-specific tagCommitStatusstructure documentation with fields, description and JSON exampleGenerated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using.
💡 Tip: You can customize your AI Description using Guidelines Learn how