fix(scripts): remove generation commit from changelogs (#534)

algolia · May 24, 2022 · 77dcc52 · 77dcc52
1 parent fdf0445
commit 77dcc52
Show file tree

Hide file tree

Showing 8 changed files with 133 additions and 108 deletions.
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -142,7 +142,8 @@ jobs:
         with:
           key: |
             ${{ matrix.client }}-${{ hashFiles(
-              format('clients/algoliasearch-client-javascript/packages/{0}/**', matrix.client)
+              format('clients/algoliasearch-client-javascript/packages/{0}/**', matrix.client),
+              'yarn.lock'
             )}}
           path: clients/algoliasearch-client-javascript/packages/${{ matrix.client }}
 
@@ -258,7 +259,8 @@ jobs:
         with:
           key: |
             algoliasearch-${{ hashFiles(
-              'clients/algoliasearch-client-javascript/packages/algoliasearch/**'
+              'clients/algoliasearch-client-javascript/packages/algoliasearch/**',
+              'yarn.lock'
             )}}
           path: clients/algoliasearch-client-javascript/packages/algoliasearch/
 

diff --git a/playground/javascript/browser/package.json b/playground/javascript/browser/package.json
@@ -6,9 +6,9 @@
     "start": "parcel index.html"
   },
   "dependencies": {
-    "@experimental-api-clients-automation/client-common": "0.2.0",
-    "@experimental-api-clients-automation/client-search": "0.2.0",
-    "@experimental-api-clients-automation/requester-browser-xhr": "0.2.0"
+    "@experimental-api-clients-automation/client-common": "0.3.0",
+    "@experimental-api-clients-automation/client-search": "0.3.0",
+    "@experimental-api-clients-automation/requester-browser-xhr": "0.3.0"
   },
   "devDependencies": {
     "parcel": "2.4.1",

diff --git a/playground/javascript/node/package.json b/playground/javascript/node/package.json
@@ -15,18 +15,18 @@
     "start:predict": "ts-node predict.ts"
   },
   "dependencies": {
-    "@experimental-api-clients-automation/algoliasearch": "0.2.0",
-    "@experimental-api-clients-automation/client-abtesting": "0.2.0",
-    "@experimental-api-clients-automation/client-analytics": "0.2.0",
-    "@experimental-api-clients-automation/client-common": "0.2.0",
-    "@experimental-api-clients-automation/client-insights": "0.2.0",
-    "@experimental-api-clients-automation/client-personalization": "0.2.0",
-    "@experimental-api-clients-automation/client-predict": "0.2.0",
-    "@experimental-api-clients-automation/client-query-suggestions": "0.2.0",
-    "@experimental-api-clients-automation/client-search": "0.2.0",
-    "@experimental-api-clients-automation/client-sources": "0.2.0",
-    "@experimental-api-clients-automation/recommend": "0.2.0",
-    "@experimental-api-clients-automation/requester-node-http": "0.2.0"
+    "@experimental-api-clients-automation/algoliasearch": "0.3.0",
+    "@experimental-api-clients-automation/client-abtesting": "0.3.0",
+    "@experimental-api-clients-automation/client-analytics": "0.3.0",
+    "@experimental-api-clients-automation/client-common": "0.3.0",
+    "@experimental-api-clients-automation/client-insights": "0.3.0",
+    "@experimental-api-clients-automation/client-personalization": "0.3.0",
+    "@experimental-api-clients-automation/client-predict": "0.3.0",
+    "@experimental-api-clients-automation/client-query-suggestions": "0.3.0",
+    "@experimental-api-clients-automation/client-search": "0.3.0",
+    "@experimental-api-clients-automation/client-sources": "0.3.0",
+    "@experimental-api-clients-automation/recommend": "0.3.0",
+    "@experimental-api-clients-automation/requester-node-http": "0.3.0"
   },
   "devDependencies": {
     "dotenv": "16.0.0",

diff --git a/scripts/release/__tests__/create-release-issue.test.ts b/scripts/release/__tests__/create-release-issue.test.ts
@@ -1,3 +1,4 @@
+import generationCommitText from '../../ci/codegen/text';
 import {
   parseCommit,
   getVersionChangesText,
@@ -49,6 +50,14 @@ describe('create release issue', () => {
         error: 'unknown-language-scope',
       });
     });
+
+    it('returns error when it is a generated commit', () => {
+      expect(
+        parseCommit(`${generationCommitText.commitStartMessage} ABCDEF`)
+      ).toEqual({
+        error: 'generation-commit',
+      });
+    });
   });
 
   describe('getVersionChangesText', () => {

diff --git a/scripts/release/create-release-issue.ts b/scripts/release/create-release-issue.ts
@@ -3,6 +3,7 @@ import chalk from 'chalk';
 import dotenv from 'dotenv';
 import semver from 'semver';
 
+import generationCommitText from '../ci/codegen/text';
 import {
   LANGUAGES,
   ROOT_ENV_PATH,
@@ -99,6 +100,12 @@ export function parseCommit(commit: string): Commit {
   let type = message.slice(0, message.indexOf(':'));
   const matchResult = type.match(/(.+)\((.+)\)/);
   if (!matchResult) {
+    if (commit.startsWith(generationCommitText.commitStartMessage)) {
+      return {
+        error: 'generation-commit',
+      };
+    }
+
     return {
       error: 'missing-language-scope',
     };
@@ -237,6 +244,12 @@ async function createReleaseIssue(): Promise<void> {
       const commit = parseCommit(commitMessage);
 
       if ('error' in commit) {
+        // We don't do anything in that case, as we don't really care about
+        // those commits
+        if (commit.error === 'generation-commit') {
+          return undefined;
+        }
+
         if (commit.error === 'missing-language-scope') {
           commitsWithoutLanguageScope.push(commitMessage);
           return undefined;

diff --git a/scripts/release/types.ts b/scripts/release/types.ts
@@ -32,6 +32,7 @@ export type PassedCommit = {
 
 export type Commit =
   | PassedCommit
+  | { error: 'generation-commit' }
   | { error: 'missing-language-scope' }
   | { error: 'unknown-language-scope' };
 

diff --git a/tests/output/javascript/package.json b/tests/output/javascript/package.json
@@ -5,18 +5,18 @@
     "test": "jest"
   },
   "dependencies": {
-    "@experimental-api-clients-automation/algoliasearch-lite": "0.2.0",
-    "@experimental-api-clients-automation/client-abtesting": "0.2.0",
-    "@experimental-api-clients-automation/client-analytics": "0.2.0",
-    "@experimental-api-clients-automation/client-common": "0.2.0",
-    "@experimental-api-clients-automation/client-insights": "0.2.0",
-    "@experimental-api-clients-automation/client-personalization": "0.2.0",
-    "@experimental-api-clients-automation/client-predict": "0.2.0",
-    "@experimental-api-clients-automation/client-query-suggestions": "0.2.0",
-    "@experimental-api-clients-automation/client-search": "0.2.0",
-    "@experimental-api-clients-automation/client-sources": "0.2.0",
-    "@experimental-api-clients-automation/recommend": "0.2.0",
-    "@experimental-api-clients-automation/requester-node-http": "0.2.0"
+    "@experimental-api-clients-automation/algoliasearch-lite": "0.3.0",
+    "@experimental-api-clients-automation/client-abtesting": "0.3.0",
+    "@experimental-api-clients-automation/client-analytics": "0.3.0",
+    "@experimental-api-clients-automation/client-common": "0.3.0",
+    "@experimental-api-clients-automation/client-insights": "0.3.0",
+    "@experimental-api-clients-automation/client-personalization": "0.3.0",
+    "@experimental-api-clients-automation/client-predict": "0.3.0",
+    "@experimental-api-clients-automation/client-query-suggestions": "0.3.0",
+    "@experimental-api-clients-automation/client-search": "0.3.0",
+    "@experimental-api-clients-automation/client-sources": "0.3.0",
+    "@experimental-api-clients-automation/recommend": "0.3.0",
+    "@experimental-api-clients-automation/requester-node-http": "0.3.0"
   },
   "devDependencies": {
     "@types/jest": "27.4.1",