chore(ci): make the cache not depends on generated files

.github/actions/cache/action.yml

@@ -15,6 +15,9 @@ inputs:
   spec:
     description: The name of the spec to restore, used for client matrix gen.
     required: false
+  specPath:
+    description: The path of the spec to hash
+    required: false
 
 runs:
   using: composite
@@ -45,14 +48,14 @@ runs:
 
     # Restore bundled specs from input: used during 'client' generation
     - name: Restore ${{ inputs.spec }} built spec
-      if: ${{ inputs.job == 'client' && inputs.spec }}
+      if: ${{ inputs.job == 'client' && inputs.spec && inputs.specPath }}
       uses: actions/cache@v3
       with:
         path: ${{ format('specs/bundled/{0}.yml', inputs.spec) }}
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            format('specs/{0}/**', inputs.spec),
+            format('specs/{0}/**', inputs.specPath),
             'specs/common/**'
           )}}
 
@@ -220,10 +223,11 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/algoliasearch/**',
-            'clients/algoliasearch-client-javascript/packages/client-search/**',
-            'clients/algoliasearch-client-javascript/packages/client-analytics/**',
-            'clients/algoliasearch-client-javascript/packages/client-personalization/**'
+            'specs/bundled/search.yml',
+            'specs/bundled/analytics.yml',
+            'specs/bundled/personalization.yml',
+            'templates/javascript/**',
+            'generators/src/**'
           )}}
 
     - name: Restore built JavaScript algoliasearch-lite client
@@ -234,10 +238,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/algoliasearch-lite/src/**',
-            'clients/algoliasearch-client-javascript/packages/algoliasearch-lite/model/**',
-            'clients/algoliasearch-client-javascript/packages/algoliasearch-lite/builds/**',
-            'clients/algoliasearch-client-javascript/packages/algoliasearch-lite/package.json',
             'specs/bundled/algoliasearch-lite.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -251,10 +251,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-search/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-search/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-search/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-search/package.json',
             'specs/bundled/search.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -268,10 +264,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/recommend/src/**',
-            'clients/algoliasearch-client-javascript/packages/recommend/model/**',
-            'clients/algoliasearch-client-javascript/packages/recommend/builds/**',
-            'clients/algoliasearch-client-javascript/packages/recommend/package.json',
             'specs/bundled/recommend.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -285,10 +277,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-query-suggestions/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-query-suggestions/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json',
             'specs/bundled/query-suggestions.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -302,10 +290,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-personalization/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-personalization/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-personalization/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-personalization/package.json',
             'specs/bundled/personalization.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -319,10 +303,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-analytics/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-analytics/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-analytics/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-analytics/package.json',
             'specs/bundled/analytics.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -336,10 +316,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-abtesting/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-abtesting/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-abtesting/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-abtesting/package.json',
             'specs/bundled/abtesting.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -353,10 +329,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-insights/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-insights/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-insights/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-insights/package.json',
             'specs/bundled/insights.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -370,10 +342,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-sources/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-sources/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-sources/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-sources/package.json',
             'specs/bundled/sources.yml',
             'templates/javascript/**',
             'generators/src/**'
@@ -387,10 +355,6 @@ runs:
         key: |
           ${{ env.CACHE_VERSION }}-${{
           hashFiles(
-            'clients/algoliasearch-client-javascript/packages/client-predict/src/**',
-            'clients/algoliasearch-client-javascript/packages/client-predict/model/**',
-            'clients/algoliasearch-client-javascript/packages/client-predict/builds/**',
-            'clients/algoliasearch-client-javascript/packages/client-predict/package.json',
             'specs/bundled/predict.yml',
             'templates/javascript/**',
             'generators/src/**'

.github/actions/setup/action.yml

@@ -13,10 +13,6 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Read current GitHub Actions cache version
-      shell: bash
-      run: echo "CACHE_VERSION=$(< .github/.cache_version)" >> $GITHUB_ENV
-
     - name: Install Node
       uses: actions/setup-node@v2
       with:

.github/workflows/check.yml

@@ -172,6 +172,7 @@ jobs:
           job: client
           language: javascript
           spec: ${{ matrix.client.name }}
+          specPath: ${{ matrix.client.specPath }}
           cache_hash: ${{ needs.setup.outputs.CACHE_COMMON_HASH }}
 
       - name: Cache '${{ matrix.client.name }}' client
@@ -182,10 +183,6 @@ jobs:
           key: |
             ${{ env.CACHE_VERSION }}-${{
             hashFiles(
-              format('{0}/src/**', matrix.client.path),
-              format('{0}/model/**', matrix.client.path),
-              format('{0}/builds/**', matrix.client.path),
-              format('{0}/package.json', matrix.client.path),
               format('specs/bundled/{0}.yml', matrix.client.name),
               'templates/javascript/**',
               'generators/src/**'
@@ -334,10 +331,11 @@ jobs:
           key: |
             ${{ env.CACHE_VERSION }}-${{
             hashFiles(
-              'clients/algoliasearch-client-javascript/packages/algoliasearch/**',
-              'clients/algoliasearch-client-javascript/packages/client-search/**',
-              'clients/algoliasearch-client-javascript/packages/client-analytics/**',
-              'clients/algoliasearch-client-javascript/packages/client-personalization/**'
+              'specs/bundled/search.yml',
+              'specs/bundled/analytics.yml',
+              'specs/bundled/personalization.yml',
+              'templates/javascript/**',
+              'generators/src/**'
             )}}
 
       - name: Build 'algoliasearch' client

clients/algoliasearch-client-javascript/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [0.1.1](https://github.com/algolia/algoliasearch-client-javascript/compare/0.1.0...0.1.1)
+
+### javascript
+- c80d0647 fix(spec): predict server (#441)
+- 12f246e7 chore: use `Client` suffix (#386)
+- be7400be fix(javascript): update version (#448)
+- b9677335 fix(javascript): add missing descriptions (#416)
+- cd565ca3 chore(javascript): fix npm publish issue (#409)
+

scripts/ci/createMatrix.ts

@@ -20,6 +20,7 @@ type ClientMatrix = BaseMatrix & {
   api: string;
   capitalizedName: string;
   camelizedName: string;
+  specPath: string;
 };
 
 type SpecMatrix = BaseMatrix;
@@ -66,6 +67,7 @@ async function getClientMatrix({
       api: `${clientName}Client`,
       capitalizedName: clientName,
       camelizedName: camelize(client),
+      specPath: client === 'algoliasearch-lite' ? 'search' : client,
     });
   }
 

scripts/release/create-release-issue.ts

@@ -2,7 +2,6 @@
 import dotenv from 'dotenv';
 import semver from 'semver';
 
-import { getNbGitDiff } from '../ci/utils';
 import {
   LANGUAGES,
   ROOT_ENV_PATH,
@@ -196,25 +195,13 @@ async function createReleaseIssue(): Promise<void> {
     );
   }
 
-  if (
-    (await getNbGitDiff({
-      head: null,
-    })) !== 0
-  ) {
-    throw new Error(
-      'Working directory is not clean. Commit all the changes first.'
-    );
-  }
-
   await run(`git rev-parse --verify refs/tags/${RELEASED_TAG}`, {
     errorMessage: '`released` tag is missing in this repository.',
   });
 
   console.log('Pulling from origin...');
-  run(`git pull`);
-
-  console.log('Pushing to origin...');
-  run(`git push`);
+  await run('git fetch origin');
+  await run('git pull');
 
   const commitsWithUnknownLanguageScope: string[] = [];
   const commitsWithoutLanguageScope: string[] = [];
@@ -295,7 +282,7 @@ async function createReleaseIssue(): Promise<void> {
     TEXT.approval,
   ].join('\n\n');
 
-  const octokit = getOctokit(process.env.GITHUB_TOKEN!);
+  const octokit = getOctokit(process.env.GITHUB_TOKEN);
 
   octokit.rest.issues
     .create({
@@ -312,6 +299,11 @@ async function createReleaseIssue(): Promise<void> {
       console.log('');
       console.log(`Release issue #${number} is ready for review.`);
       console.log(`  > ${url}`);
+    })
+    .catch((error) => {
+      console.log('Unable to create the release issue');
+
+      throw new Error(error);
     });
 }