fix(ci): make generation comment clearer

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,45 @@
+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 }}

.github/workflows/codegen.yml

@@ -0,0 +1,81 @@
+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/shortcuts/api-clients-automation/issues/new)_"
+      `);
+    });
+
+    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/shortcuts/api-clients-automation/pull/42/commits/myCommit).
+          🔍 Browse the generated code on branch [myBranch](https://github.com/shortcuts/api-clients-automation/tree/myBranch): [theGeneratedCommit](https://github.com/shortcuts/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,4 @@ 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.'
-  );
-}
-
 cleanGeneratedBranch(args[0]);

scripts/ci/codegen/cleanGeneratedBranch.ts

@@ -1,113 +1,42 @@
 /* eslint-disable no-console */
-import { Octokit } from '@octokit/rest';
-
 import { run } from '../../common';
-import { configureGitHubAuthor, OWNER, REPO } from '../../release/common';
-
-if (!process.env.GITHUB_TOKEN) {
-  throw new Error('Environment variable `GITHUB_TOKEN` does not exist.');
-}
+import { configureGitHubAuthor } from '../../release/common';
 
 const PR_NUMBER = parseInt(process.env.PR_NUMBER || '0', 10);
-const FOLDERS_TO_CHECK = ['clients', 'specs/bundled'];
-// this should be changed to the bot name once we have the logs
-const BOT_NAME = 'shortcuts';
-
-const octokit = new Octokit({
-  auth: `token ${process.env.GITHUB_TOKEN}`,
-});
-
-async function getCommentBody(commit: string, branch: string): Promise<string> {
-  const repoUrl = `https://github.com/${OWNER}/${REPO}`;
-  const generatedCommit = await run('git show -s --format=%H');
-  const header = `✔️ codegen triggered on commit [${commit}](${repoUrl}/pull/${PR_NUMBER}/commits/${commit}).`;
-  const body = `🔍 Browse the generated code on branch [${branch}](${repoUrl}/tree/${branch}): [${generatedCommit}](${repoUrl}/commit/${generatedCommit}).`;
-
-  return `${header}
-
-${body}`;
-}
+const FOLDERS_TO_CHECK = 'clients specs/bundled';
 
 /**
- * Add or update comment to the current `PR_NUMBER`.
+ * Push generated code for the current `JOB` and `CLIENT` on a `generated/` branch.
  */
-async function upsertCommentToPullRequest(
-  baseCommit: string,
-  generatedCodeBranch: string
-): Promise<void> {
-  const baseOctokitConfig = {
-    owner: OWNER,
-    repo: REPO,
-    issue_number: PR_NUMBER,
-  };
-
-  try {
-    // Search for a previous comment from our bot.
-    const previousComment = await octokit.rest.issues
-      .listComments(baseOctokitConfig)
-      .then(
-        (res) =>
-          res.data.filter(
-            (comment) =>
-              comment.user?.login === BOT_NAME &&
-              // this shouldn't be needed once we have a proper bot running
-              comment.body?.startsWith('✔️ codegen triggered on commit')
-          )[0]
-      );
-    const commentBody = await getCommentBody(baseCommit, generatedCodeBranch);
-
-    if (previousComment?.id) {
-      console.log(`Previous bot comment found ${previousComment.id}.`);
-
-      await octokit.rest.issues.updateComment({
-        ...baseOctokitConfig,
-        body: commentBody,
-        comment_id: previousComment.id,
-      });
-
-      return;
-    }
-
-    console.log('Creating new comment.');
-    await octokit.rest.issues.createComment({
-      ...baseOctokitConfig,
-      body: commentBody,
-    });
-  } catch (e) {
-    throw new Error(`Error with GitHub API: ${e}`);
+export async function pushGeneratedCode(): Promise<void> {
+  if (!process.env.GITHUB_TOKEN) {
+    throw new Error('Environment variable `GITHUB_TOKEN` does not exist.');
   }
-}
 
-/**
- * Push generated code for the current `JOB` and `CLIENT` on a `generated/` branch.
- */
-async function pushGeneratedCode(): Promise<void> {
   await configureGitHubAuthor();
 
   const baseBranch = await run('git branch --show-current');
   console.log(`Checking codegen status on '${baseBranch}'.`);
 
   // determine generated branch name based on current branch
   const generatedCodeBranch = `generated/${baseBranch}`;
-  const generatedFolders = FOLDERS_TO_CHECK.join(' ');
 
   if (
     (await run(
-      `git status --porcelain ${generatedFolders} | wc -l | tr -d ' '`
+      `git status --porcelain ${FOLDERS_TO_CHECK} | wc -l | tr -d ' '`
     )) === '0'
   ) {
     console.log(`No generated code changes found for '${baseBranch}'.`);
 
+    if (PR_NUMBER) {
+      await run(`yarn workspace scripts upsertGenerationComment noGen`);
+    }
+
     return;
   }
 
   await run(`yarn workspace scripts cleanGeneratedBranch ${baseBranch}`);
 
-  const baseCommit = await run(`git show ${baseBranch} -s --format=%H`);
-  console.log(
-    `Codegen triggered on branch '${baseBranch}' for commit ${baseCommit}.`
-  );
-
   console.log(`Creating branch for generated code: '${generatedCodeBranch}'`);
   await run(`git branch ${generatedCodeBranch}`);
   const commitMessage =
@@ -116,15 +45,16 @@ async function pushGeneratedCode(): Promise<void> {
 Co-authored-by: %an <%ae>"`);
 
   console.log(
-    `Pushing code for folders '${generatedFolders}' to generated branch: ${generatedCodeBranch}`
+    `Pushing code for folders '${FOLDERS_TO_CHECK}' to generated branch: ${generatedCodeBranch}`
   );
   await run(`git checkout ${generatedCodeBranch}`);
-  await run(`git add ${generatedFolders}`);
+  await run(`git add ${FOLDERS_TO_CHECK}`);
   await run(`git commit -m "${commitMessage}"`);
   await run(`git push origin ${generatedCodeBranch}`);
+  await run(`git checkout ${baseBranch}`);
 
   if (PR_NUMBER) {
-    await upsertCommentToPullRequest(baseCommit, generatedCodeBranch);
+    await run(`yarn workspace scripts upsertGenerationComment codegen`);
   }
 }