fix(ci): make generation comment clearer (#258)

Author: shortcuts

.github/actions/setup/action.yml

@@ -2,6 +2,11 @@ name: Setup
 
 description: Setup CI environment.
 
+inputs:
+  type:
+    description: Type of setup, `minimal` will only run the JavaScript installation.
+    required: false
+
 runs:
   using: composite
   steps:
@@ -10,13 +15,15 @@ runs:
       run: echo "CACHE_VERSION=$(< .github/.cache_version)" >> $GITHUB_ENV
 
     - name: Install Java
+      if: inputs.type != 'minimal'
       uses: actions/setup-java@v2
       with:
         distribution: zulu
         java-version: 11.0.4
         cache: gradle
 
     - name: Validate gradle wrapper
+      if: inputs.type != 'minimal'
       uses: gradle/wrapper-validation-action@v1
 
     - name: Install Node
@@ -29,6 +36,7 @@ runs:
       uses: ./.github/actions/cache
 
     - name: Setting diff outputs variables
+      if: inputs.type != 'minimal'
       id: diff
       shell: bash
       run: |
@@ -61,6 +69,7 @@ runs:
         echo "::set-output name=ORIGIN_BRANCH::$origin"
 
     - name: Compute specs matrix
+      if: inputs.type != 'minimal'
       id: spec-matrix
       shell: bash
       run: |
@@ -81,6 +90,7 @@ runs:
         echo "::set-output name=RUN_SPECS::$run"
 
     - name: Compute the JS client build matrix
+      if: inputs.type != 'minimal'
       id: js-matrix
       shell: bash
       run: |
@@ -117,6 +127,7 @@ runs:
         fi
 
     - name: Compute the Java client build matrix
+      if: inputs.type != 'minimal'
       id: java-matrix
       shell: bash
       run: |
@@ -137,6 +148,7 @@ runs:
         echo "::set-output name=RUN_CLIENT::$run"
 
     - name: Compute the PHP client build matrix
+      if: inputs.type != 'minimal'
       id: php-matrix
       shell: bash
       run: |

.github/workflows/codegen-cleanup.yml

@@ -0,0 +1,51 @@
+name: Codegen
+
+on:
+  pull_request:
+    types: [opened, synchronize, closed]
+
+jobs:
+  notification:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+    if: (github.event.action == 'opened' || github.event.action == 'synchronize') && github.event.number
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          type: minimal
+
+      - name: Add notification comment
+        run: yarn workspace scripts upsertGenerationComment notification
+        env:
+          GITHUB_TOKEN: ${{ secrets.TOKEN_GENERATE_BOT }}
+          PR_NUMBER: ${{ github.event.number }}
+
+  cleanup:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+    if: github.event.action == 'closed'
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Setup
+        uses: ./.github/actions/setup
+        with:
+          type: minimal
+
+      - 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 }}

.github/workflows/codegen.yml

@@ -0,0 +1,89 @@
+import { cleanGeneratedBranch } from '../cleanGeneratedBranch';
+import { pushGeneratedCode } from '../pushGeneratedCode';
+import commentText from '../text';
+import {
+  getCommentBody,
+  upsertGenerationComment,
+} from '../upsertGenerationComment';
+
+describe('codegen', () => {
+  describe('cleanGeneratedBranch', () => {
+    it('throws without parameters', async () => {
+      await expect(
+        // @ts-expect-error a parameter is required
+        cleanGeneratedBranch()
+      ).rejects.toThrow(
+        'The base branch should be passed as a cli parameter of the `cleanGeneratedBranch` script.'
+      );
+    });
+  });
+
+  describe('pushGeneratedCode', () => {
+    it('throws without GITHUB_TOKEN environment variable', async () => {
+      await expect(pushGeneratedCode()).rejects.toThrow(
+        'Environment variable `GITHUB_TOKEN` does not exist.'
+      );
+    });
+  });
+
+  describe('upsertGenerationComment', () => {
+    it('throws without parameter', async () => {
+      await expect(
+        // @ts-expect-error a parameter is required
+        upsertGenerationComment()
+      ).rejects.toThrow(
+        '`upsertGenerationComment` requires a `trigger` parameter (`codegen` | `notification`).'
+      );
+    });
+
+    it('throws without PR_NUMBER environment variable', async () => {
+      process.env.GITHUB_TOKEN = 'foo';
+
+      await expect(upsertGenerationComment('codegen')).rejects.toThrow(
+        '`upsertGenerationComment` requires a `PR_NUMBER` environment variable.'
+      );
+    });
+  });
+
+  describe('getCommentBody', () => {
+    it('returns the right comment for a `notification` trigger', async () => {
+      expect(await getCommentBody('notification')).toMatchInlineSnapshot(`
+        "🔨 The codegen job will run at the end of the CI.
+
+        _Make sure your last commit does not contains generated code, it will be automatically pushed by our CI._"
+      `);
+    });
+
+    it('returns the right comment for a `noGen` trigger', async () => {
+      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)._"
+      `);
+    });
+
+    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)."
+      `);
+    });
+
+    describe('text', () => {
+      it('creates a comment body for the parameters', () => {
+        expect(
+          commentText.codegen.body(
+            'myBranch',
+            'myCommit',
+            42,
+            'theGeneratedCommit'
+          )
+        ).toMatchInlineSnapshot(`
+          "🔨 Triggered by commit [myCommit](https://github.com/algolia/api-clients-automation/pull/42/commits/myCommit).
+          🔍 Browse the generated code on branch [myBranch](https://github.com/algolia/api-clients-automation/tree/myBranch): [theGeneratedCommit](https://github.com/algolia/api-clients-automation/commit/theGeneratedCommit)."
+        `);
+      });
+    });
+  });
+});

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

@@ -4,7 +4,13 @@ import { run } from '../../common';
 /**
  * Deletes a branch for its `generated/${headRef}` name on origin.
  */
-async function cleanGeneratedBranch(headRef: string): Promise<void> {
+export async function cleanGeneratedBranch(headRef: string): Promise<void> {
+  if (!headRef) {
+    throw new Error(
+      'The base branch should be passed as a cli parameter of the `cleanGeneratedBranch` script.'
+    );
+  }
+
   const generatedCodeBranch = `generated/${headRef}`;
 
   if (!(await run(`git ls-remote --heads origin ${generatedCodeBranch}`))) {
@@ -22,10 +28,6 @@ async function cleanGeneratedBranch(headRef: string): Promise<void> {
 
 const args = process.argv.slice(2);
 
-if (!args || args.length === 0) {
-  throw new Error(
-    'The base branch should be passed as a cli parameter of the `cleanGeneratedBranch` script.'
-  );
+if (require.main === module) {
+  cleanGeneratedBranch(args[0]);
 }
-
-cleanGeneratedBranch(args[0]);