Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
WalkthroughAdded documentation for a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/2.0/reference/pipelines/configurations-as-code/api.mdx (1)
300-303: Use<Tabs>/<TabItem>for provider-specific behavior in this MDX section.Line 302 presents meaningful GitHub vs GitLab differences inline; this should be split into tabs per docs convention.
Suggested MDX adjustment
Controls whether Pipelines updates a single PR/MR comment in-place on each push instead of creating a new comment. -- **`true`** — A single comment is updated on every push. On GitHub, the comment edit history preserves previous plan outputs. On GitLab, previous outputs are silently overwritten since GitLab does not have comment edit history. +- **`true`** — A single comment is updated on every push. + <Tabs> + <TabItem value="github" label="GitHub" default> + The comment edit history preserves previous plan outputs. + </TabItem> + <TabItem value="gitlab" label="GitLab"> + Previous outputs are silently overwritten because GitLab does not preserve comment edit history. + </TabItem> + </Tabs> - **`false`** (default) — A new comment is created for each push.As per coding guidelines, "Whenever presenting information that diverges between GitHub and GitLab, use the and components to distinguish the two sets of information UNLESS the distinction is just changing one word."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx` around lines 300 - 303, Split the provider-specific sentence about comment edit history into provider tabs using the <Tabs> and <TabItem> MDX components: keep the main description ("Controls whether Pipelines updates a single PR/MR comment...") and then replace the inline GitHub/GitLab difference in the **`true`** bullet with two tabbed panels—one <TabItem value="github"> explaining GitHub preserves comment edit history and one <TabItem value="gitlab"> explaining GitLab silently overwrites previous outputs—while leaving the **`false`** bullet unchanged; use the <Tabs> wrapper to contain the two <TabItem> entries so the documentation follows the provider-specific convention.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx`:
- Around line 300-303: Split the provider-specific sentence about comment edit
history into provider tabs using the <Tabs> and <TabItem> MDX components: keep
the main description ("Controls whether Pipelines updates a single PR/MR
comment...") and then replace the inline GitHub/GitLab difference in the
**`true`** bullet with two tabbed panels—one <TabItem value="github"> explaining
GitHub preserves comment edit history and one <TabItem value="gitlab">
explaining GitLab silently overwrites previous outputs—while leaving the
**`false`** bullet unchanged; use the <Tabs> wrapper to contain the two
<TabItem> entries so the documentation follows the provider-specific convention.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 3f7104b5-9170-4650-9205-61febd13185e
📒 Files selected for processing (3)
docs/2.0/docs/pipelines/installation/branch-protection.mdxdocs/2.0/docs/pipelines/installation/gitlab-branch-protection.mddocs/2.0/reference/pipelines/configurations-as-code/api.mdx
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx`:
- Around line 314-316: Replace the inline provider-specific sentence about the
`false` behavior with a Tabs component that has two TabItem panes labeled
"GitHub" and "GitLab"; put the existing sentence about a single comment being
updated on every push and comment-edit-history preserving previous outputs into
the GitHub TabItem, and put the sentence stating GitLab silently overwrites
previous outputs into the GitLab TabItem, ensuring the boolean option
descriptions (`**true**` and `**false**`) remain unchanged and the new
<Tabs>/<TabItem> elements replace only the provider-differing text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 34f0c9a9-bae0-475b-bf36-5ca806abd528
📒 Files selected for processing (3)
docs/2.0/docs/pipelines/installation/branch-protection.mdxdocs/2.0/docs/pipelines/installation/gitlab-branch-protection.mddocs/2.0/reference/pipelines/configurations-as-code/api.mdx
✅ Files skipped from review due to trivial changes (2)
- docs/2.0/docs/pipelines/installation/gitlab-branch-protection.md
- docs/2.0/docs/pipelines/installation/branch-protection.mdx
Comment on lines
+314
to
+316
| - **`true`** (default) — A new comment is created for each push, preserving the full history of plan outputs. | ||
| - **`false`** — A single comment is updated on every push. On GitHub, the comment edit history preserves previous plan outputs. On GitLab, previous outputs are silently overwritten since GitLab does not have comment edit history. | ||
|
|
Contributor
There was a problem hiding this comment.
Use Tabs/TabItem for GitHub vs GitLab behavior differences.
Line 315 describes materially different behavior per provider, so this should be split into GitHub and GitLab tabs instead of inline text.
Suggested docs update
- **`true`** (default) — A new comment is created for each push, preserving the full history of plan outputs.
-- **`false`** — A single comment is updated on every push. On GitHub, the comment edit history preserves previous plan outputs. On GitLab, previous outputs are silently overwritten since GitLab does not have comment edit history.
+- **`false`** — A single comment is updated on every push.
+
+<Tabs>
+ <TabItem value="github" label="GitHub" default>
+ The comment edit history preserves previous plan outputs.
+ </TabItem>
+ <TabItem value="gitlab" label="GitLab">
+ Previous outputs are overwritten because GitLab does not provide comment edit history.
+ </TabItem>
+</Tabs>As per coding guidelines, "docs/**/*.mdx: Whenever presenting information that diverges between GitHub and GitLab, use the and components to distinguish the two sets of information UNLESS the distinction is just changing one word."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - **`true`** (default) — A new comment is created for each push, preserving the full history of plan outputs. | |
| - **`false`** — A single comment is updated on every push. On GitHub, the comment edit history preserves previous plan outputs. On GitLab, previous outputs are silently overwritten since GitLab does not have comment edit history. | |
| - **`true`** (default) — A new comment is created for each push, preserving the full history of plan outputs. | |
| - **`false`** — A single comment is updated on every push. | |
| <Tabs> | |
| <TabItem value="github" label="GitHub" default> | |
| The comment edit history preserves previous plan outputs. | |
| </TabItem> | |
| <TabItem value="gitlab" label="GitLab"> | |
| Previous outputs are overwritten because GitLab does not provide comment edit history. | |
| </TabItem> | |
| </Tabs> | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx` around lines 314
- 316, Replace the inline provider-specific sentence about the `false` behavior
with a Tabs component that has two TabItem panes labeled "GitHub" and "GitLab";
put the existing sentence about a single comment being updated on every push and
comment-edit-history preserving previous outputs into the GitHub TabItem, and
put the sentence stating GitLab silently overwrites previous outputs into the
GitLab TabItem, ensuring the boolean option descriptions (`**true**` and
`**false**`) remain unchanged and the new <Tabs>/<TabItem> elements replace only
the provider-differing text.
Contributor
|
Nit: the new |
Resonance1584
previously approved these changes
Apr 9, 2026
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/2.0/reference/pipelines/configurations-as-code/api.mdx (1)
322-324:⚠️ Potential issue | 🟡 MinorUse GitHub/GitLab tabs for the provider-specific
falsebehavior.Line 323 describes materially different provider behavior inline. Please split this into
<Tabs>/<TabItem>blocks so each provider’s behavior is explicit and consistent with docs conventions.Suggested update
- **`true`** (default) — A new comment is created for each push, preserving the full history of plan outputs. -- **`false`** — A single comment is updated on every push. On GitHub, the comment edit history preserves previous plan outputs. On GitLab, previous outputs are silently overwritten since GitLab does not have comment edit history. +- **`false`** — A single comment is updated on every push. + +<Tabs> + <TabItem value="github" label="GitHub" default> + The comment edit history preserves previous plan outputs. + </TabItem> + <TabItem value="gitlab" label="GitLab"> + Previous outputs are silently overwritten because GitLab does not provide comment edit history. + </TabItem> +</Tabs>As per coding guidelines, “
docs/**/*.mdx: Whenever presenting information that diverges between GitHub and GitLab, use the<Tabs>and<TabItem>components to distinguish the two sets of information UNLESS the distinction is just changing one word.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx` around lines 322 - 324, Replace the inline provider-specific sentence for the `false` option with a provider-separated tabbed block using the <Tabs> and <TabItem> components: keep the `true` line as-is, and for the `false` line create a <Tabs> containing two <TabItem> entries labeled "GitHub" and "GitLab"; put the GitHub text "A single comment is updated on every push. On GitHub, the comment edit history preserves previous plan outputs." in the GitHub <TabItem> and the GitLab text "A single comment is updated on every push. On GitLab, previous outputs are silently overwritten since GitLab does not have comment edit history." in the GitLab <TabItem>, ensuring the markup follows existing docs conventions for tabs.
🧹 Nitpick comments (1)
docs/2.0/reference/pipelines/configurations-as-code/api.mdx (1)
297-327: Consider adding a self-link and astatus_updateattributes heading for consistency.Line 302 introduces the block, but unlike other block docs it doesn’t point to a dedicated attributes section. Adding a “See more [below]” link and a
### \status_update` block attributes` heading above Line 317 would align this section with the rest of the page structure.Suggested doc-structure tweak
<HclListItemDescription> *Added in Pipelines v4.12.0* Controls how Pipelines posts status comments on pull/merge requests. Nested inside the `repository` block. +See more [below](`#status_update-block-attributes`). </HclListItemDescription> <HclListItemExample> @@ </HclListItemExample> </HclListItem> +### `status_update` block attributes + <HclListItem name="new_comment_per_push" requirement="optional" type="boolean">🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx` around lines 297 - 327, Add a self-link and an attributes heading for the status_update block to match other blocks: under the existing "status_update" HclListItem (nested in the repository block) add a short "See more below" anchor that links to a new section, then insert a heading like "### `status_update` block attributes" (followed by the explanation of attributes such as `new_comment_per_push`) so the `status_update` block has a dedicated attributes section consistent with other documented blocks.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx`:
- Around line 322-324: Replace the inline provider-specific sentence for the
`false` option with a provider-separated tabbed block using the <Tabs> and
<TabItem> components: keep the `true` line as-is, and for the `false` line
create a <Tabs> containing two <TabItem> entries labeled "GitHub" and "GitLab";
put the GitHub text "A single comment is updated on every push. On GitHub, the
comment edit history preserves previous plan outputs." in the GitHub <TabItem>
and the GitLab text "A single comment is updated on every push. On GitLab,
previous outputs are silently overwritten since GitLab does not have comment
edit history." in the GitLab <TabItem>, ensuring the markup follows existing
docs conventions for tabs.
---
Nitpick comments:
In `@docs/2.0/reference/pipelines/configurations-as-code/api.mdx`:
- Around line 297-327: Add a self-link and an attributes heading for the
status_update block to match other blocks: under the existing "status_update"
HclListItem (nested in the repository block) add a short "See more below" anchor
that links to a new section, then insert a heading like "### `status_update`
block attributes" (followed by the explanation of attributes such as
`new_comment_per_push`) so the `status_update` block has a dedicated attributes
section consistent with other documented blocks.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: a53624b4-e54c-45e1-b78e-efeb80453e54
📒 Files selected for processing (1)
docs/2.0/reference/pipelines/configurations-as-code/api.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation