feat: Add JSON body support for incoming webhook parameters #2100
+286
−33
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for specifying incoming webhook parameters in the JSON request body, marks the legacy URL query parameter method as insecure, and updates tests and documentation accordingly.
- Introduced separate tests for legacy and JSON body methods in both GitLab and GitHub webhook tests.
- Updated the listener logic in the adapter to detect incoming webhook parameters from both query and JSON body, logging a warning for legacy usage.
- Revised documentation to clearly indicate the recommended JSON body method and deprecate the legacy query parameter approach.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/gitlab_incoming_webhook_test.go | Added tests for both legacy and JSON body methods for GitLab incoming webhooks |
| test/github_incoming_test.go | Updated tests to support legacy and JSON body approaches for GitHub incoming webhooks |
| pkg/adapter/incoming_test.go | Replaced hardcoded HTTP methods with http.MethodPost and added tests for legacy warnings |
| pkg/adapter/incoming.go | Updated the webhook detection logic to handle JSON body parsing and legacy warnings |
| docs/content/docs/guide/incoming_webhook.md | Updated documentation to describe both legacy (deprecated) and JSON body methods |
Comments suppressed due to low confidence (1)
test/gitlab_incoming_webhook_test.go:98
- [nitpick] The variable name 'incomingSecreteValue' appears to have a typo. Consider renaming it to 'incomingSecretValue' for improved clarity.
opts.ControllerURL, randomedString, randomedString, "pipelinerun-incoming", incomingSecreteValue
zakisk
reviewed
May 28, 2025
|
/lgtm |
![pipelines-as-code[bot]](https://avatars.githubusercontent.com/in/112592?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congrats @chmouel your PR Has been approved 🎉
✅ Pull Request Approved
Approval Status:
- Required Approvals: 1
- Current Approvals: 1
👥 Reviewers Who Approved:
| Reviewer | Permission Level | Approval Status |
|---|---|---|
| @zakisk | admin |
✅ |
📝 Next Steps
- Ensure all required checks pass
- Comply with branch protection rules
- Request a maintainer to merge using the
/mergecommand (or merge it
directly if you have repository permission).
Automated by the PAC Boussole 🧭
* Implemented support for passing incoming webhook parameters in the JSON request body. * Marked the legacy method using URL query parameters for secrets as insecure. * Added a warning log when the legacy method is detected. * Updated documentation to describe the new recommended method and the deprecated legacy method. * Updated end-to-end tests to cover both legacy and new methods. Fixes openshift-pipelines#1093 JIRA: https://issues.redhat.com/browse/SRVKP-7678 Signed-off-by: Chmouel Boudjnah <[email protected]>
chmouel
force-pushed
the
issue-1093-use-post-for-incoming-webhook
branch
from
fd51934 to
9f5b520
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
request body.
deprecated legacy method.
Fixes #1093
JIRA: https://issues.redhat.com/browse/SRVKP-7678
Signed-off-by: Chmouel Boudjnah [email protected]