fix(scripts): update release PR and process (#554)

shortcuts · web-flow · commit 134ca0212a9d · 2022-05-25T14:36:15.000+02:00
diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml
@@ -78,7 +78,7 @@ runs:
       shell: bash
       run: |
         previousCommit=${{ github.event.before }}
-        baseRef=${{ inputs.workflow_name == 'process-release' && 'main' || github.base_ref }}
+        baseRef=${{ github.base_ref }}
         origin=$( [[ -z $baseRef ]] && echo $previousCommit || echo "origin/$baseRef" )
 
         yarn workspace scripts setRunVariables "$origin"
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -230,7 +230,7 @@ jobs:
         run: yarn cli cts run ${{ matrix.client.language }}
 
       - name: Zip artifact before storing
-        run: zip -q -r clients-${{ matrix.client.language }}.zip ${{ matrix.client.path }} ${{ matrix.client.testsOutputPath }} -x "${{ matrix.client.path }}/node_modules/.**"
+        run: zip -r -y clients-${{ matrix.client.language }}.zip ${{ matrix.client.path }} ${{ matrix.client.testsOutputPath }} -x "**/node_modules/**" "**/node_modules/.**" "clients/algoliasearch-client-javascript/.yarn/**"
 
       - name: Store ${{ matrix.client.language }} clients
         uses: actions/upload-artifact@v3
diff --git a/package.json b/package.json
@@ -24,7 +24,7 @@
     "github-actions:lint": "eslint --ext=yml .github/",
     "postinstall": "husky install && yarn workspace eslint-plugin-automation-custom build",
     "playground:browser": "yarn workspace javascript-browser-playground start",
-    "release": "yarn workspace scripts createReleaseIssue",
+    "release": "yarn workspace scripts createReleasePR",
     "scripts:lint": "eslint --ext=ts scripts/",
     "scripts:test": "yarn workspace scripts test",
     "specs:fix": "eslint --ext=yml specs/$0 --fix",
diff --git a/scripts/common.ts b/scripts/common.ts
@@ -272,7 +272,7 @@ export function ensureGitHubToken(): string {
 export function getOctokit(): Octokit {
   const token = ensureGitHubToken();
   return new Octokit({
-    auth: `token ${token}`,
+    auth: token,
   });
 }
 
diff --git a/scripts/package.json b/scripts/package.json
@@ -4,7 +4,7 @@
   "scripts": {
     "cleanGeneratedBranch": "ts-node ci/codegen/cleanGeneratedBranch.ts",
     "createMatrix": "ts-node ci/githubActions/createMatrix.ts",
-    "createReleaseIssue": "ts-node release/create-release-issue.ts",
+    "createReleasePR": "ts-node release/createReleasePR.ts",
     "pre-commit": "./ci/husky/pre-commit.js",
     "pushGeneratedCode": "ts-node ci/codegen/pushGeneratedCode.ts",
     "renovateWeeklyPR": "ts-node ci/githubActions/renovateWeeklyPR.ts",
diff --git a/scripts/release/__tests__/createReleasePR.test.ts b/scripts/release/__tests__/createReleasePR.test.ts
@@ -5,9 +5,9 @@ import {
   getSkippedCommitsText,
   decideReleaseStrategy,
   readVersions,
-} from '../create-release-issue';
+} from '../createReleasePR';
 
-describe('create release issue', () => {
+describe('createReleasePR', () => {
   it('reads versions of the current language', () => {
     expect(readVersions()).toEqual({
       java: {
@@ -92,10 +92,10 @@ describe('create release issue', () => {
           },
         })
       ).toMatchInlineSnapshot(`
-      "- javascript: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
-      - java: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
-      - php: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**"
-    `);
+              "- javascript: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
+              - java: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
+              - php: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**"
+          `);
     });
 
     it('generates text for version changes with a language with no commit', () => {
@@ -118,10 +118,10 @@ describe('create release issue', () => {
           },
         })
       ).toMatchInlineSnapshot(`
-      "- javascript: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
-      - java: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
-      - ~php: 0.0.1 (no commit)~"
-    `);
+              "- javascript: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
+              - java: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
+              - ~php: 0.0.1 (no commit)~"
+          `);
     });
 
     it('generates text for version changes with a language to skip', () => {
@@ -144,11 +144,11 @@ describe('create release issue', () => {
           },
         })
       ).toMatchInlineSnapshot(`
-      "- javascript: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
-      - ~java: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**~
-        - No \`feat\` or \`fix\` commit, thus unchecked by default.
-      - php: 0.0.1 -> **\`minor\` _(e.g. 0.1.0)_**"
-    `);
+              "- javascript: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**
+              - ~java: 0.0.1 -> **\`patch\` _(e.g. 0.0.2)_**~
+                - No \`feat\` or \`fix\` commit, thus unchecked by default.
+              - php: 0.0.1 -> **\`minor\` _(e.g. 0.1.0)_**"
+          `);
     });
   });
 
@@ -363,47 +363,117 @@ describe('create release issue', () => {
     });
   });
 
-  it('generates text for skipped commits', () => {
-    expect(
-      getSkippedCommitsText({
-        commitsWithoutLanguageScope: [],
-        commitsWithUnknownLanguageScope: [],
-      })
-    ).toMatchInlineSnapshot(`"_(None)_"`);
-
-    expect(
-      getSkippedCommitsText({
-        commitsWithoutLanguageScope: [
-          'abcdefg fix: something',
-          'abcdefg fix: somethin2',
-        ],
+  describe('getSkippedCommitsText', () => {
+    it('does not generate text if there is no commits', () => {
+      expect(
+        getSkippedCommitsText({
+          commitsWithoutLanguageScope: [],
+          commitsWithUnknownLanguageScope: [],
+        })
+      ).toMatchInlineSnapshot(`"_(None)_"`);
+    });
 
-        commitsWithUnknownLanguageScope: [
-          'abcdef2 fix(pascal): what',
-          'abcdef2 fix(pascal): what is that',
-        ],
-      })
-    ).toMatchInlineSnapshot(`
-      "</p>
-      <p>It doesn't mean these commits are being excluded from the release. It means they're not taken into account when the release process figured out the next version number, and updated the changelog.</p>
-
-      <details>
-        <summary>
-          <i>Commits without language scope:</i>
-        </summary>
-
-        - abcdefg fix: something
-      - abcdefg fix: somethin2
-      </details>
-
-      <details>
-        <summary>
-          <i>Commits with unknown language scope:</i>
-        </summary>
-
-        - abcdef2 fix(pascal): what
-      - abcdef2 fix(pascal): what is that
-      </details>"
-    `);
+    it('generates text for skipped commits', () => {
+      expect(
+        getSkippedCommitsText({
+          commitsWithoutLanguageScope: [
+            'abcdefg fix: something',
+            'abcdefg fix: somethin2',
+          ],
+
+          commitsWithUnknownLanguageScope: [
+            'abcdef2 fix(pascal): what',
+            'abcdef2 fix(pascal): what is that',
+          ],
+        })
+      ).toMatchInlineSnapshot(`
+        "
+        <p>It doesn't mean these commits are being excluded from the release. It means they're not taken into account when the release process figured out the next version number, and updated the changelog.</p>
+
+        <details>
+          <summary>
+            <i>Commits without language scope:</i>
+          </summary>
+
+          - abcdefg fix: something
+        - abcdefg fix: somethin2
+        </details>
+
+        <details>
+          <summary>
+            <i>Commits with unknown language scope:</i>
+          </summary>
+
+          - abcdef2 fix(pascal): what
+        - abcdef2 fix(pascal): what is that
+        </details>"
+      `);
+    });
+
+    it('limits the size of the commits to 15 if there is too many', () => {
+      const fakeCommitsWithoutLanguageScope: string[] = [];
+      const fakeCommitsWithUnknownLanguageScope: string[] = [];
+
+      for (let i = 0; i < 100; i++) {
+        fakeCommitsWithoutLanguageScope.push(`abcdefg${i} fix: something`);
+        fakeCommitsWithUnknownLanguageScope.push(
+          `abcdefg${i} fix(pascal): something`
+        );
+      }
+
+      expect(
+        getSkippedCommitsText({
+          commitsWithoutLanguageScope: fakeCommitsWithoutLanguageScope,
+          commitsWithUnknownLanguageScope: fakeCommitsWithUnknownLanguageScope,
+        })
+      ).toMatchInlineSnapshot(`
+        "
+        <p>It doesn't mean these commits are being excluded from the release. It means they're not taken into account when the release process figured out the next version number, and updated the changelog.</p>
+
+        <details>
+          <summary>
+            <i>Commits without language scope:</i>
+          </summary>
+
+          - abcdefg0 fix: something
+        - abcdefg1 fix: something
+        - abcdefg2 fix: something
+        - abcdefg3 fix: something
+        - abcdefg4 fix: something
+        - abcdefg5 fix: something
+        - abcdefg6 fix: something
+        - abcdefg7 fix: something
+        - abcdefg8 fix: something
+        - abcdefg9 fix: something
+        - abcdefg10 fix: something
+        - abcdefg11 fix: something
+        - abcdefg12 fix: something
+        - abcdefg13 fix: something
+        - abcdefg14 fix: something
+        </details>
+
+        <details>
+          <summary>
+            <i>Commits with unknown language scope:</i>
+          </summary>
+
+          - abcdefg0 fix(pascal): something
+        - abcdefg1 fix(pascal): something
+        - abcdefg2 fix(pascal): something
+        - abcdefg3 fix(pascal): something
+        - abcdefg4 fix(pascal): something
+        - abcdefg5 fix(pascal): something
+        - abcdefg6 fix(pascal): something
+        - abcdefg7 fix(pascal): something
+        - abcdefg8 fix(pascal): something
+        - abcdefg9 fix(pascal): something
+        - abcdefg10 fix(pascal): something
+        - abcdefg11 fix(pascal): something
+        - abcdefg12 fix(pascal): something
+        - abcdefg13 fix(pascal): something
+        - abcdefg14 fix(pascal): something
+        </details>"
+      `);
+    });
   });
 });
diff --git a/scripts/release/__tests__/updateAPIVersions.test.ts b/scripts/release/__tests__/updateAPIVersions.test.ts
@@ -1,8 +1,8 @@
-import { getVersionChangesText } from '../create-release-issue';
-import { getVersionsToRelease } from '../process-release';
+import { getVersionChangesText } from '../createReleasePR';
 import TEXT from '../text';
+import { getVersionsToRelease } from '../updateAPIVersions';
 
-describe('process release', () => {
+describe('updateAPIversions', () => {
   it('gets versions to release', () => {
     const versions = getVersionsToRelease(`
     ## Version Changes
@@ -20,8 +20,8 @@ describe('process release', () => {
     expect(versions.php?.releaseType).toEqual('patch');
   });
 
-  it('parses issue body correctly', () => {
-    // This test is a glue between create-release-issue and process-release.
+  it('correctly reads clients version and their next release type', () => {
+    // This test is a glue between createReleasePR and updateAPIVersions.
     const issueBody = [
       TEXT.versionChangeHeader,
       getVersionChangesText({
diff --git a/scripts/release/createReleasePR.ts b/scripts/release/createReleasePR.ts
diff --git a/scripts/release/updateAPIVersions.ts b/scripts/release/updateAPIVersions.ts
diff --git a/website/docs/contributing/release-process.md b/website/docs/contributing/release-process.md

Original file line number	Diff line number	Diff line change
`@@ -272,7 +272,7 @@ export function ensureGitHubToken(): string {`
`272`	`272`	`export function getOctokit(): Octokit {`
`273`	`273`	`const token = ensureGitHubToken();`
`274`	`274`	`return new Octokit({`
`275`		- auth: `token ${token}`,
	`275`	`+ auth: token,`
`276`	`276`	`});`
`277`	`277`	`}`
`278`	`278`