Add tech preview shortcode

And make the matching body payload a tech preview. Explains why the behaviour may be erratics on the matching body payload with the gitops comments. Signed-off-by: Chmouel Boudjnah <[email protected]>
openshift-pipelines · Nov 23, 2023 · 811cf7c · 811cf7c
1 parent 2217f5d
commit 811cf7c
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/content/docs/guide/authoringprs.md b/docs/content/docs/guide/authoringprs.md
@@ -196,6 +196,8 @@ commit title on `push`
 
 ### Matching PipelineRun on body payload
 
+{{< tech_preview "Matching PipelineRun on body payload" >}}
+
 The payload body as passed by the Git provider is available in the CEL
 variable as `body` and you can use this expression to do any filtering on
 anything the Git provider is sending over:
@@ -213,6 +215,31 @@ will only match if the pull request is targeting the `main` branch, the author
 of the pull request is called `superuser` and the action is `synchronize` (ie:
 an update occurred on a pull request)
 
+{{< hint info >}}
+When matching the body payload in a Pull Request, the GitOps comments such as
+`/retest` won't be working as expected.
+
+The payload body will become of the comment and not the original pull request
+payload.
+
+Consequently, when a pull request event occurs, like opening or updating a pull
+request, the CEL body payload may not align with the defined specifications.
+
+To be able to retest your Pull Request when using a CEL on bod payload,
+you can make a dummy update to the Pull Request by sending a new SHA with this
+git command:
+
+```bash
+# assuming you are on the branch you want to retest
+# and the upstream remote are set
+git commit --amend --no-edit && \
+  git push --force-with-lease
+```
+
+or close/open the pull request.
+
+{{< /hint >}}
+
 ### Matching PipelineRun on request header
 
 You can do some further filtering on the headers as passed by the Git provider

diff --git a/docs/layouts/shortcodes/tech_preview.html b/docs/layouts/shortcodes/tech_preview.html
@@ -0,0 +1,8 @@
+<blockquote class="book-hint danger">
+  <b>{{ .Get 0 }}</b> is a <b>Technology Preview</b> feature only. Technology Preview features
+  are not currently supported and might not be functionally complete. We do
+  not recommend using them in production. These features provide early access
+  to an upcoming Pipelines-as-Code features, enabling you to test functionality
+  and provide feedback during the development process.
+</blockquote>
+