docs: add validation failure note to GitLab comment strategy#2793
docs: add validation failure note to GitLab comment strategy#2793EsteeCohen wants to merge 1 commit into
Conversation
Signed-off-by: Estee Cohen <estherco@post.bgu.ac.il>
|
|
There was a problem hiding this comment.
Code Review
This pull request updates the GitLab provider documentation to clarify the behavior of the comment_strategy setting. Specifically, it adds an informational callout explaining that comment_strategy only applies to PipelineRun status comments, whereas validation errors in the .tekton/ directory are always posted. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
theakshaypant
left a comment
There was a problem hiding this comment.
Thank you @EsteeCohen for taking care of this!
chmouel
left a comment
There was a problem hiding this comment.
Thanks for the contribution! While i don't think this isn't just a GitLab issue, we don't have it documented elsewhere, so it's good to add.
Is there a way to integrate this as regular text in the documentation part of a sentence instead of a callout? The reason behind is that we (as contributor) naturally tend to use callouts for every specific documentation fix, the documentation becomes fragmented and harder to read as a proper guide.
|
@chmouel yes no problem, this makes sense :) |
📝 Description of the Change
The GitLab documentation explained how to disable status comments using
comment_strategy: "disable_all", but did not mention that validation failurecomments are always posted regardless of this setting. This note already exists
for GitHub but was missing from the GitLab section.
This PR adds a callout to the GitLab provider documentation clarifying that
comment_strategyonly applies to PipelineRun status comments, and that commentsabout errors validating PipelineRuns in the
.tekton/directory are alwaysposted even when
comment_strategyis set todisable_all.🔗 Linked GitHub Issue
Fixes #
Fixes #2269
🧪 Testing Strategy
🤖 AI Assistance
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.