From 3a18975b13c7ec5b981b484778772a07ab153a39 Mon Sep 17 00:00:00 2001
From: Joshua Schmid <jaiks@posteo.de>
Date: Mon, 14 Oct 2024 17:02:53 +0200
Subject: [PATCH] chore(ci): run ai assisted changelog reviews

---
 .github/workflows/changelog-reviewer.yml      | 33 +++++++++
 .../workflows/styleguide/changelog-prompt.txt | 67 +++++++++++++++++++
 2 files changed, 100 insertions(+)
 create mode 100644 .github/workflows/changelog-reviewer.yml
 create mode 100644 .github/workflows/styleguide/changelog-prompt.txt

diff --git a/.github/workflows/changelog-reviewer.yml b/.github/workflows/changelog-reviewer.yml
new file mode 100644
index 000000000000..ce17c6b0ac1e
--- /dev/null
+++ b/.github/workflows/changelog-reviewer.yml
@@ -0,0 +1,33 @@
+name: Changelog Review
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+    # only run when these files have changed
+    paths:
+      - 'changelog/**/**.yml'
+
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: ${{github.event.pull_request.head.repo.full_name}}
+          ref: ${{github.event.pull_request.head.ref}}
+          submodules: false
+      - uses: jschmid1/chatgpt-action@3e0350fcecd16c2dacd3e26f753abc4078b8a012
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+        with:
+          debug: false
+          action: review
+          path_filters: "changelog/**/**.yml"
+          review_comment_lgtm: false
+          custom_prompt_path: ".github/workflows/styleguide/changelog-prompt.txt"
diff --git a/.github/workflows/styleguide/changelog-prompt.txt b/.github/workflows/styleguide/changelog-prompt.txt
new file mode 100644
index 000000000000..5bfde847d648
--- /dev/null
+++ b/.github/workflows/styleguide/changelog-prompt.txt
@@ -0,0 +1,67 @@
+Hi ChatGPT, I have a pull request with title "$title" and the description is as follows,
+
+> $description
+
+The filename:
+$filename
+
+The patch:
+```diff
+$patch
+```
+
+Check the changelog message, if present, and verify that it adheres to the styleguide:
+
+The styleguide:
+  * The message is written in past-tense
+  * The message is relatively short (less than 200 characters)
+  * The message is structurally sound (starts with a verb, ends with a period)
+  * The spelling is correct
+  * When you are referring to the user, use “You” and “your” instead of “user” and “their”.
+  * When you are writing a bug fix description that fixes something back to its original state, use the wording “Fixed an issue where…”
+  * When you are writing a bug fix description that changes the functionality so its different than the original state, use wording that describes how it functions now, ex. “[feature] now does [explanation of new function]”
+  * When you are writing breaking changes, explain what the change is and provide information about how a user can correct their environment.
+  * When you are writing deprecations/removals, explain what is being removed/deprecated and a timeline for deprecation/removal.
+  * The scope can only be one of:
+    * Performance
+		* Configuration
+		* Core
+		* PDK
+		* Plugin
+		* Admin
+		* Clustering
+		* Default
+  * When you are writing a message for a change with "scope: Plugin" then ensure that it is prefixed with plugin name, ex. 'message: "**rate-limiting**: ..."'
+
+Good examples would be:
+  * Fixed a bug in the login page where ...
+  * Added a new feature for the dashboard that..
+  * Users can now use analytics to create graphs based on the latency of their services.
+  * Fixed an issue where Kong Gateway failed to generate a keyring when RBAC was enabled.
+  * Websocket requests now generate balancer spans when tracing is enabled.
+
+Bad examples would be:
+  * You can now use analytics to create graphs based on the latency of your services.
+  * Kong Gateway failed to generate a keyring when RBAC was enabled.
+  * Fixes Websocket tracing.
+
+The answer should adhere to the following restrictions:
+
+- Respond with a structure that is equal to the patch that you were asked to review. Only replace the parts that you saw a problem in.
+- When giving an answer, please enumerate the issues using bullet points.
+- Please provide a suggestion for the changelog message if it does not meet the above criteria.
+- Always add the complete final suggestion in a GitHub markdown block like this:
+
+```suggestion [Your complete suggestion here] ```
+
+
+When you had suggestions please add the Styleguide defined above as a collapsable markdown element using the syntax
+
+<details>
+  <summary>Changelog Styleguide</summary>
+
+  (Add the styleguide here)
+
+</details>
+
+No need to ask further questions.