add cleanup trigger

Author: shortcuts

.github/workflows/codegen.yml

@@ -43,3 +43,9 @@ jobs:
 
       - name: Clean previously generated branch
         run: yarn workspace scripts cleanGeneratedBranch ${{ github.head_ref }}
+
+      - name: Add cleanup comment
+        run: yarn workspace scripts upsertGenerationComment cleanup
+        env:
+          GITHUB_TOKEN: ${{ secrets.TOKEN_GENERATE_BOT }}
+          PR_NUMBER: ${{ github.event.number }}

scripts/ci/codegen/__tests__/codegen.test.ts

@@ -58,7 +58,15 @@ describe('codegen', () => {
       expect(await getCommentBody('noGen')).toMatchInlineSnapshot(`
         "✗ No code generated.
 
-        _If you believe this is an issue on our side, please [open an issue](https://github.com/algolia/api-clients-automation/issues/new?template=Bug_report.md)_"
+        _If you believe this is an issue on our side, please [open an issue](https://github.com/algolia/api-clients-automation/issues/new?template=Bug_report.md)._"
+      `);
+    });
+
+    it('returns the right comment for a `cleanup` trigger', async () => {
+      expect(await getCommentBody('cleanup')).toMatchInlineSnapshot(`
+        "✗ The generated branch has been deleted.
+
+        If the PR has been merged, you can check the generated code on the [\`generated/main\` branch](https://github.com/algolia/api-clients-automation/tree/generated/main)."
       `);
     });
 

scripts/ci/codegen/text.ts

@@ -9,7 +9,11 @@ export default {
   },
   noGen: {
     header: '✗ No code generated.',
-    body: `_If you believe this is an issue on our side, please [open an issue](${REPO_URL}/issues/new?template=Bug_report.md)_`,
+    body: `_If you believe this is an issue on our side, please [open an issue](${REPO_URL}/issues/new?template=Bug_report.md)._`,
+  },
+  cleanup: {
+    header: '✗ The generated branch has been deleted.',
+    body: `If the PR has been merged, you can check the generated code on the [\`generated/main\` branch](${REPO_URL}/tree/generated/main).`,
   },
   codegen: {
     header: '✔️ Code generated!',

scripts/ci/codegen/upsertGenerationComment.ts

@@ -14,12 +14,16 @@ const octokit = new Octokit({
 });
 
 const args = process.argv.slice(2);
-const allowedTriggers = ['notification', 'codegen', 'noGen'];
+const allowedTriggers = ['notification', 'codegen', 'noGen', 'cleanup'];
 
 type Trigger = keyof typeof commentText;
 
 export async function getCommentBody(trigger: Trigger): Promise<string> {
-  if (trigger === 'notification' || trigger === 'noGen') {
+  if (
+    trigger === 'notification' ||
+    trigger === 'noGen' ||
+    trigger === 'cleanup'
+  ) {
     return `${commentText[trigger].header}
 
 ${commentText[trigger].body}`;