Skip to content

docs: add validation failure note to GitLab comment strategy#2793

Open
EsteeCohen wants to merge 1 commit into
tektoncd:mainfrom
EsteeCohen:fix/2269-gitlab-validation-note
Open

docs: add validation failure note to GitLab comment strategy#2793
EsteeCohen wants to merge 1 commit into
tektoncd:mainfrom
EsteeCohen:fix/2269-gitlab-validation-note

Conversation

@EsteeCohen

Copy link
Copy Markdown

📝 Description of the Change

The GitLab documentation explained how to disable status comments using
comment_strategy: "disable_all", but did not mention that validation failure
comments 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_strategy only applies to PipelineRun status comments, and that comments
about errors validating PipelineRuns in the .tekton/ directory are always
posted even when comment_strategy is set to disable_all.

🔗 Linked GitHub Issue

Fixes #
Fixes #2269

🧪 Testing Strategy

  • Not Applicable

🤖 AI Assistance

  • I have not used any AI assistance for this PR.

✅ Submitter Checklist

  • [x ] 📝 My commit messages are clear, informative, and follow the project's How to write a git commit message guide. The Gitlint linter ensures in CI it's properly validated
  • [x ] ✨ I have ensured my commit message prefix (e.g., fix:, feat:) matches the "Type of Change" I selected above.
  • ♽ I have run make test and make lint locally to check for and fix any
    issues. For an efficient workflow, I have considered installing
    pre-commit and running pre-commit install to
    automate these checks.
  • [x ] 📖 I have added or updated documentation for any user-facing changes.
  • 🧪 I have added sufficient unit tests for my code changes.
  • 🎁 I have added end-to-end tests where feasible. See README for more details.
  • 🔎 I have addressed any CI test flakiness or provided a clear reason to bypass it.
  • If adding a provider feature, I have filled in the following and updated the provider documentation:
    • GitHub App
    • GitHub Webhook
    • Gitea/Forgejo
    • GitLab
    • Bitbucket Cloud
    • Bitbucket Data Center

Signed-off-by: Estee Cohen <estherco@post.bgu.ac.il>
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jun 20, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: EsteeCohen / name: Estee Cohen (b89991f)

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 theakshaypant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you @EsteeCohen for taking care of this!

@chmouel chmouel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@EsteeCohen

EsteeCohen commented Jun 22, 2026

Copy link
Copy Markdown
Author

@chmouel yes no problem, this makes sense :)
I’ll take care of that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: GitLab comment strategy missing validation failure note

3 participants