feat(github): add update comment strategy for GitHub by theakshaypant · Pull Request #2481 · tektoncd/pipelines-as-code

theakshaypant · 2026-02-16T16:38:27Z

📝 Description of the Change

This PR adds an update comment strategy for GitHub pull requests. When thsi comment strategy is used, PAC creates a single comment per PipelineRun and update it with the latest status and commit SHA on re-execution.

Changes:

Implementation of the update comment strategy.
Documentation for configuring and using this option.
E2E tests covering:
- CEL error replacement
- Multiple PipelineRuns
- Regex character handling in comments

👨🏻‍ Linked Jira

https://issues.redhat.com/browse/SRVKP-10453

🔗 Linked GitHub Issue

N/A

🚀 Type of Change

🧪 Testing Strategy

🤖 AI Assistance

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

If you have used AI assistance, please provide the following details:

Which LLM was used?

Extent of AI Assistance:

Documentation and research only
Unit tests or E2E tests only
Code generation (parts of the code)
Full code generation (most of the PR)
PR description and comments
Commit message(s)

Important

If the majority of the code in this PR was generated by an AI, please add a Co-authored-by trailer to your commit message.
For example:

Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com

**💡You can use the script ./hack/add-llm-coauthor.sh to automatically add
these co-author trailers to your commits.

✅ Submitter Checklist

pipelines-as-code · 2026-02-16T16:38:52Z

🔍 PR Lint Feedback

Note: This automated check helps ensure your PR follows our contribution guidelines.

⚠️ Items that need attention:

🤖 AI attribution

The following commits lack an explicit AI attribution footer:

2aefc3d feat(github): add update comment strategy for GitHub
7b1084b docs(repository): document update comment strategy

If no AI assistance was used for a commit, you can ignore this warning.
Otherwise add an Assisted-by: or Co-authored-by: footer referencing the AI used.

ℹ️ Next Steps

Review and address the items above
Push new commits to update this PR
This comment will be automatically updated when issues are resolved

🔧 Admin Tools (click to expand)

Automated Issue/Ticket Creation:

/issue-create - Generate a GitHub issue from this PR content using AI
/jira-create - Create a SRVKP Jira ticket from this PR content using AI

⚠️ Important: Always review and edit generated content before finalizing tickets/issues.
The AI-generated content should be used as a starting point and may need adjustments.

These commands are available to maintainers and will post the generated content as PR comments for review.

_{🤖 This feedback was generated automatically by the PR CI system}

gemini-code-assist · 2026-02-16T16:38:53Z

Summary of Changes

Hello @theakshaypant, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant enhancement for GitHub integration by implementing an "update" comment strategy. This new feature consolidates PipelineRun status updates into a single, continuously updated comment on a pull request, rather than generating a new comment for each status change or re-execution. This change aims to improve the user experience by reducing notification volume and keeping the pull request conversation cleaner.

Highlights

New GitHub Comment Strategy: Introduced a new update comment strategy for GitHub, allowing a single PipelineRun comment to be updated instead of creating multiple new ones, thus reducing notification noise.
Comprehensive End-to-End Tests: Added extensive end-to-end tests to validate the update comment strategy, covering scenarios such as CEL error replacement, handling multiple PipelineRuns, and ensuring correct behavior with regex characters in PipelineRun names.
Documentation Update: Updated the official documentation to clearly describe the new update comment strategy and its usage for GitHub repositories.

Changelog

config/300-repositories.yaml
- Added "update" as a valid comment_strategy option for GitHub repositories within the configuration schema.
docs/content/docs/guide/repositorycrd.md
- Documented the new "update" comment strategy for GitHub, explaining its behavior and benefits in detail.
pkg/apis/pipelinesascode/v1alpha1/types.go
- Extended the CommentStrategy enumeration in GithubSettings to include the new "update" option.
pkg/provider/github/status.go
- Implemented the core logic for the "update" comment strategy, including a new formatPipelineComment function to structure the updated comments with appropriate emojis and status details.
pkg/provider/provider.go
- Defined new constants for UpdateCommentStrategy and DisableAllCommentStrategy, along with a PlrStatusCommentPrefixTemplate and an IsCommentStrategyUpdate helper function for comment management.
test/github_comment_strategy_update_test.go
- Added new end-to-end tests to verify the functionality of the "update" comment strategy, covering CEL error handling, multiple PipelineRuns, and special characters in PipelineRun names.
test/pkg/github/pr.go
- Modified PushFilesToRef to support updating existing Git references and introduced a new helper function UpdateFilesInRef to facilitate testing scenarios requiring ref updates.
test/testdata/failures/pipelinerun-invalid-cel.yaml
- Updated the test PipelineRun YAML to include a target-namespace annotation for improved test setup.
test/testdata/pipelinerun-regex-chars-brackets.yaml
- Added a new test PipelineRun YAML specifically designed to test PipelineRun names containing bracket characters.
test/testdata/pipelinerun-regex-chars-dots.yaml
- Added a new test PipelineRun YAML specifically designed to test PipelineRun names containing dot characters.

Activity

Implemented the initial feature for the GitHub update comment strategy.
Developed comprehensive end-to-end tests to ensure the robustness and correctness of the new comment strategy.
Documented the new update comment strategy to provide clear guidance for users.
Utilized AI assistance (Claude) for generating parts of the unit/E2E tests and commit messages.
This pull request depends on feat(gitlab): add update comment stategy #2446 for related changes.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a new 'update' comment strategy for GitHub, allowing a single comment per PipelineRun to be updated, which helps reduce notification noise. However, a potential Markdown/HTML injection vulnerability exists because the user-controlled PipelineRun name is used without sanitization in HTML comment markers and the visible comment body, which could allow an attacker to inject malicious content or break out of the comment structure. Additionally, the review identified duplicated logic in pkg/provider/github/status.go, opportunities to improve E2E test stability by replacing time.Sleep with polling, and minor inconsistencies in regular expressions.

pkg/provider/github/status.go

gemini-code-assist · 2026-02-16T16:41:43Z

test/github_comment_strategy_update_test.go

+	defer g.TearDown(ctx, t)
+
+	g.Cnx.Clients.Log.Infof("Waiting for CEL error comment to be created")
+	time.Sleep(15 * time.Second)


Using time.Sleep can lead to flaky tests, especially in E2E environments where timing can vary. It would be more robust to use a polling mechanism with a timeout to wait for the expected condition (e.g., a comment to be created). The project's twait package might have helpers for this, or you could implement a simple polling loop. This applies to other time.Sleep calls in this file as well.

test/github_comment_strategy_update_test.go

theakshaypant

Have not duplicated the code in 2446 so expect the CI to fail.

pkg/provider/provider.go

test/github_comment_strategy_update_test.go

pkg/provider/github/status.go

theakshaypant · 2026-02-19T11:03:15Z

/retest go-testing

chmouel · 2026-02-19T11:12:16Z

/lgtm

pipelines-as-code

Congrats @theakshaypant your PR Has been approved 🎉

✅ Pull Request Approved

Approval Status:

Required Approvals: 1
Current Approvals: 1

👥 Reviewers Who Approved:

Reviewer	Permission Level	Approval Status
@chmouel	`admin`	✅

📝 Next Steps

Ensure all required checks pass
Comply with branch protection rules
Request a maintainer to merge using the /merge command (or merge it
directly if you have repository permission).

Automated by the PAC Boussole 🧭

chmouel · 2026-02-19T11:24:15Z

can you update the PR description properly (ie as a sentence)? that would help the release note

theakshaypant · 2026-02-19T11:41:16Z

can you update the PR description properly (ie as a sentence)? that would help the release note

Done. Will keep that in mind for the future.

theakshaypant · 2026-02-19T12:35:43Z

For reference, e2e tests cover the scenarios described in #2446 (comment)

pkg/provider/github/status.go

Implement "update" comment strategy for GitHub pull requests that updates a single comment per PipelineRun instead of creating new comments on every trigger. Jira: https://issues.redhat.com/browse/SRVKP-10453 Signed-off-by: Akshay Pant <akshay.akshaypant@gmail.com>

theakshaypant · 2026-02-23T05:46:49Z

/retest

zakisk · 2026-02-23T06:22:48Z

/retest

zakisk · 2026-02-23T06:34:13Z

/lgtm

pipelines-as-code

Congrats @theakshaypant your PR Has been approved 🎉

✅ Pull Request Approved

Approval Status:

Required Approvals: 1
Current Approvals: 2

👥 Reviewers Who Approved:

Reviewer	Permission Level	Approval Status
@zakisk	`admin`	✅
@chmouel	`admin`	✅

📝 Next Steps

Ensure all required checks pass
Comply with branch protection rules
Request a maintainer to merge using the /merge command (or merge it
directly if you have repository permission).

Automated by the PAC Boussole 🧭

zakisk · 2026-02-23T06:42:54Z

test/github_comment_strategy_update_test.go

+// 1. A CEL error comment is posted for a PLR
+// 2. After fixing the CEL error with a new commit, the same comment is updated with success status
+// 3. Only one comment exists.
+func TestGithubCommentStrategyUpdateCELErrorReplacement(t *testing.T) {


@theakshaypant the test you've added is failing in E2E

Needed a change after the rebase, fixed in 1e50ff9

Add E2E tests for update comment strategy: CEL error replacement, multiple PLRs, and regex character handling. Add UpdateFilesInRef helper for updating files in existing branches. Signed-off-by: Akshay Pant <akshay.akshaypant@gmail.com> Assisted-by: Claude Sonnet 4.5 (via Claude Code

Add documentation for update comment strategy option. This strategy creates a single comment per PipelineRun that gets updated with new status and commit SHA on re-execution. Signed-off-by: Akshay Pant <akshay.akshaypant@gmail.com>

pipelines-as-code bot added documentation Improvements or additions to documentation feature New feature or request github labels Feb 16, 2026

gemini-code-assist bot reviewed Feb 16, 2026

View reviewed changes

theakshaypant commented Feb 16, 2026

View reviewed changes

pkg/provider/provider.go Show resolved Hide resolved

test/github_comment_strategy_update_test.go Show resolved Hide resolved

theakshaypant force-pushed the SRVKP-10453-github-update-comment-strategy branch from 50e0920 to bb9236d Compare February 19, 2026 10:34

theakshaypant commented Feb 19, 2026

View reviewed changes

pkg/provider/github/status.go Show resolved Hide resolved

theakshaypant force-pushed the SRVKP-10453-github-update-comment-strategy branch from bb9236d to 76c3181 Compare February 19, 2026 10:39

theakshaypant marked this pull request as ready for review February 19, 2026 11:11

pipelines-as-code bot approved these changes Feb 19, 2026

View reviewed changes

zakisk reviewed Feb 19, 2026

View reviewed changes

pkg/provider/github/status.go Show resolved Hide resolved

theakshaypant force-pushed the SRVKP-10453-github-update-comment-strategy branch from fc71e3a to 65b8af8 Compare February 23, 2026 05:45

zakisk approved these changes Feb 23, 2026

View reviewed changes

pipelines-as-code bot approved these changes Feb 23, 2026

View reviewed changes

zakisk reviewed Feb 23, 2026

View reviewed changes

theakshaypant added 2 commits February 23, 2026 12:48

docs(repository): document update comment strategy

7b1084b

Add documentation for update comment strategy option. This strategy creates a single comment per PipelineRun that gets updated with new status and commit SHA on re-execution. Signed-off-by: Akshay Pant <akshay.akshaypant@gmail.com>

theakshaypant force-pushed the SRVKP-10453-github-update-comment-strategy branch from 65b8af8 to 7b1084b Compare February 23, 2026 07:18

theakshaypant merged commit 490183d into tektoncd:main Feb 23, 2026
13 checks passed

theakshaypant deleted the SRVKP-10453-github-update-comment-strategy branch February 23, 2026 07:49

Conversation

theakshaypant commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description of the Change

👨🏻‍ Linked Jira

🔗 Linked GitHub Issue

🚀 Type of Change

🧪 Testing Strategy

🤖 AI Assistance

✅ Submitter Checklist

Uh oh!

pipelines-as-code bot commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 PR Lint Feedback

⚠️ Items that need attention:

🤖 AI attribution

ℹ️ Next Steps

Uh oh!

gemini-code-assist bot commented Feb 16, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist bot Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

theakshaypant left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theakshaypant commented Feb 19, 2026

Uh oh!

chmouel commented Feb 19, 2026

Uh oh!

pipelines-as-code bot left a comment

Choose a reason for hiding this comment

✅ Pull Request Approved

👥 Reviewers Who Approved:

📝 Next Steps

Uh oh!

chmouel commented Feb 19, 2026

Uh oh!

theakshaypant commented Feb 19, 2026

Uh oh!

theakshaypant commented Feb 19, 2026

Uh oh!

Uh oh!

theakshaypant commented Feb 23, 2026

Uh oh!

zakisk commented Feb 23, 2026

Uh oh!

zakisk commented Feb 23, 2026

Uh oh!

pipelines-as-code bot left a comment

Choose a reason for hiding this comment

✅ Pull Request Approved

👥 Reviewers Who Approved:

📝 Next Steps

Uh oh!

zakisk Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

theakshaypant Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

theakshaypant commented Feb 16, 2026 •

edited

Loading

pipelines-as-code bot commented Feb 16, 2026 •

edited

Loading