Skip to content

Conversation

@vim-zz
Copy link
Collaborator

@vim-zz vim-zz commented Dec 3, 2025

image Screenshot 2025-12-03 at 8 56 07

✨ PR Description

Purpose: Add documentation for the CommitStatus structure in gitStream's context variables to enable integration with external CI systems.
Main changes:

  • Added pr.commit_statuses field to the context variables table with GitHub-specific tag
  • Created CommitStatus structure documentation with fields, description and JSON example
  • Added note about gitStream's behavior regarding commit status events collection

Generated 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

@vim-zz vim-zz requested a review from EladKohavi December 3, 2025 06:56
Copy link

@orca-security-us orca-security-us bot left a 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
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@gitstream-cm gitstream-cm bot requested a review from a team December 3, 2025 07:00
gitstream-cm[bot]
gitstream-cm bot previously approved these changes Dec 3, 2025
Copy link
Collaborator

@MishaKav MishaKav left a comment

Choose a reason for hiding this comment

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

Lg

@gitstream-cm gitstream-cm bot requested a review from a team December 3, 2025 07:16
@gitstream-cm gitstream-cm bot dismissed their stale review December 3, 2025 07:16

Review dismissed

@vim-zz vim-zz enabled auto-merge (squash) December 3, 2025 09:26
Copy link
Contributor

@gitstream-cm gitstream-cm bot left a 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",
Copy link
Contributor

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.

Suggested change
"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

@vim-zz vim-zz merged commit 48ffb65 into main Dec 3, 2025
11 checks passed
@vim-zz vim-zz deleted the add-commit-status branch December 3, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants