Merge pull request #224 from commerce-docs/ds_upd-test-pr

Update testing workflow
AdobeDocs · Dec 14, 2023 · cf2534a · cf2534a
2 parents f0e3f2e + 437059f
commit cf2534a
Show file tree

Hide file tree

Showing 6 changed files with 143 additions and 158 deletions.
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -8,7 +8,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Node v16
+      - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'

diff --git a/.github/workflows/index.yml b/.github/workflows/index.yml
@@ -21,7 +21,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Node v16
+      - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -58,7 +58,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Node v16
+      - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'

diff --git a/.github/workflows/stage.yml b/.github/workflows/stage.yml
@@ -1,139 +1,139 @@
 ---
-  name: Staging deployment
-  on:
-    workflow_dispatch:
-      inputs:
-        clean:
-          description: 'Clean cache (yes|no)'
-          required: true
-          default: 'yes'
-        excludeSubfolder:
-          description: 'Exclude a subfolder from deletion'
-          required: false
-          default: ''
-  jobs:
-    set-state:
-      runs-on: ubuntu-latest
-      outputs:
-        clean_cache: ${{ contains(github.event.inputs.clean, 'yes') }}
-        path_prefix: ${{ steps.get_path_prefix.outputs.path_prefix }}
-        branch_short_ref: ${{ steps.get_branch.outputs.branch }}
-        exclude_subfolder: ${{ github.event.inputs.excludeSubfolder }}
-      steps:
-        - name: Checkout
-          uses: actions/checkout@v4
-  
-        - name: Get pathPrefix
-          uses: actions/github-script@v6
-          id: get_path_prefix
-          with:
-            script: |
-              const script = require('./.github/scripts/get-path-prefix.js');
-              script({ core });
-            result-encoding: string
-        - name: Get branch name
-          shell: bash
-          run: echo "branch=${GITHUB_REF#refs/heads/}" >> "$GITHUB_OUTPUT"
-          id: get_branch
-  
-    echo-state:
-      needs: [set-state]
-      runs-on: ubuntu-latest
-      steps:
-        - run: echo "Clean cache - ${{ needs.set-state.outputs.clean_cache }}"
-        - run: echo "Repository org - ${{ github.event.repository.owner.login }}"
-        - run: echo "Repository name - ${{ github.event.repository.name }}"
-        - run: echo "Repository branch - ${{ needs.set-state.outputs.branch_short_ref }}"
-        - run: echo "Path prefix - ${{ needs.set-state.outputs.path_prefix }}"
-        - run: echo "Exclude subfolder - ${{ needs.set-state.outputs.exclude_subfolder }}"
-  
-    pre-build:
-      needs: [set-state]
-      runs-on: ubuntu-latest
-      steps:
-        - name: check dev azure connection string
-          if: env.AIO_AZURE_DEV_CONNECTION_STRING == null
-          run: |
-            echo "::error::Please set the Azure Blob Storage connection string as AIO_AZURE_DEV_CONNECTION_STRING in Github Secrets"
-            exit 1
-          env:
-            AIO_AZURE_DEV_CONNECTION_STRING: ${{ secrets.AIO_AZURE_DEV_CONNECTION_STRING }}
-  
-    build:
-      defaults:
-        run:
-          shell: bash
-      needs: [set-state, pre-build]
-      runs-on: ubuntu-latest
-      steps:
-        - name: Checkout
-          uses: actions/checkout@v4
-  
-        - name: Setup Node v16
-          uses: actions/setup-node@v3
-          with:
-            node-version-file: '.nvmrc'
-            cache: 'yarn'
-            cache-dependency-path: 'yarn.lock'
-  
-        - name: Enable Corepack for Yarn
-          run: corepack enable
-  
-        - name: Install Dependencies
-          run: yarn install
-          env:
-            YARN_ENABLE_IMMUTABLE_INSTALLS: false
-  
-        - name: Gatsby Cache
-          uses: actions/[email protected]
-          with:
-            path: |
-              public
-              .cache
-            key: ${{ needs.set-state.outputs.branch_short_ref }}-gatsby-cache-${{ github.run_id }}
-            restore-keys: |
-              ${{ needs.set-state.outputs.branch_short_ref }}-gatsby-cache-
-  
-        - name: Clean Cache
-          if: needs.set-state.outputs.clean_cache == 'true'
-          run: yarn clean
-  
-        - name: Build site
-          run: yarn build
-          env:
-            PREFIX_PATHS: true # equivalent to --prefix-paths flag for 'gatsby build'
-            PATH_PREFIX: ${{ needs.set-state.outputs.path_prefix }}
-            GATSBY_ADOBE_LAUNCH_SRC: ${{ secrets.AIO_ADOBE_LAUNCH_DEV_SRC }}
-            GATSBY_ADDITIONAL_ADOBE_ANALYTICS_ACCOUNTS: ${{ secrets.AIO_REPORT_SUITE_DEV}}
-            GATSBY_ADOBE_ANALYTICS_ENV: 'dev'
-            REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            REPO_OWNER: ${{ github.event.repository.owner.login }}
-            REPO_NAME: ${{ github.event.repository.name }}
-            REPO_BRANCH: ${{ needs.set-state.outputs.branch_short_ref }}
-            GOOGLE_OAUTH_CLIENT_ID: ${{ secrets.GOOGLE_OAUTH_CLIENT_ID }}
-            GOOGLE_OAUTH_CLIENT_SECRET: ${{ secrets.GOOGLE_OAUTH_CLIENT_SECRET }}
-            GOOGLE_DOCS_TOKEN: ${{ secrets.GOOGLE_DOCS_TOKEN }}
-            GOOGLE_DOCS_FOLDER_ID: ${{ secrets.GOOGLE_DOCS_FOLDER_ID }}
-            GATSBY_IMS_SRC: ${{ secrets.AIO_IMS_DEV_SRC }}
-            GATSBY_IMS_CONFIG: ${{ secrets.AIO_IMS_DEV_CONFIG }}
-            GATSBY_ALGOLIA_APPLICATION_ID: ${{ secrets.AIO_ALGOLIA_APPLICATION_ID }}
-            GATSBY_ALGOLIA_SEARCH_API_KEY: ${{ secrets.AIO_ALGOLIA_SEARCH_API_KEY }}
-            ALGOLIA_INDEXATION_MODE: skip
-            GATSBY_ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME || github.event.repository.name }}
-            GATSBY_FEDS_PRIVACY_ID: ${{ secrets.AIO_FEDS_PRIVACY_ID }}
-            GATSBY_SITE_DOMAIN_URL: https://developer-stage.adobe.com
-  
-        - name: Deploy
-          uses: AdobeDocs/static-website-deploy@master
-          with:
-            enabled-static-website: 'true'
-            source: 'public'
-            target: ${{ needs.set-state.outputs.path_prefix }}
-            connection-string: ${{ secrets.AIO_AZURE_DEV_CONNECTION_STRING }}
-            remove-existing-files: 'true'
-            exclude-subfolder: ${{ needs.set-state.outputs.exclude_subfolder }}
-        - name: Purge Fastly Cache
-          uses: AdobeDocs/gatsby-fastly-purge-action@master
-          with:
-            fastly-token: ${{ secrets.AIO_FASTLY_TOKEN }}
-            fastly-url: '${{ secrets.AIO_FASTLY_DEV_URL}}${{ needs.set-state.outputs.path_prefix }}'
+name: Staging deployment
+on:
+  workflow_dispatch:
+    inputs:
+      clean:
+        description: 'Clean cache (yes|no)'
+        required: true
+        default: 'yes'
+      excludeSubfolder:
+        description: 'Exclude a subfolder from deletion'
+        required: false
+        default: ''
+jobs:
+  set-state:
+    runs-on: ubuntu-latest
+    outputs:
+      clean_cache: ${{ contains(github.event.inputs.clean, 'yes') }}
+      path_prefix: ${{ steps.get_path_prefix.outputs.path_prefix }}
+      branch_short_ref: ${{ steps.get_branch.outputs.branch }}
+      exclude_subfolder: ${{ github.event.inputs.excludeSubfolder }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Get pathPrefix
+        uses: actions/github-script@v6
+        id: get_path_prefix
+        with:
+          script: |
+            const script = require('./.github/scripts/get-path-prefix.js');
+            script({ core });
+          result-encoding: string
+      - name: Get branch name
+        shell: bash
+        run: echo "branch=${GITHUB_REF#refs/heads/}" >> "$GITHUB_OUTPUT"
+        id: get_branch
+
+  echo-state:
+    needs: [set-state]
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Clean cache - ${{ needs.set-state.outputs.clean_cache }}"
+      - run: echo "Repository org - ${{ github.event.repository.owner.login }}"
+      - run: echo "Repository name - ${{ github.event.repository.name }}"
+      - run: echo "Repository branch - ${{ needs.set-state.outputs.branch_short_ref }}"
+      - run: echo "Path prefix - ${{ needs.set-state.outputs.path_prefix }}"
+      - run: echo "Exclude subfolder - ${{ needs.set-state.outputs.exclude_subfolder }}"
+
+  pre-build:
+    needs: [set-state]
+    runs-on: ubuntu-latest
+    steps:
+      - name: check dev azure connection string
+        if: env.AIO_AZURE_DEV_CONNECTION_STRING == null
+        run: |
+          echo "::error::Please set the Azure Blob Storage connection string as AIO_AZURE_DEV_CONNECTION_STRING in Github Secrets"
+          exit 1
+        env:
+          AIO_AZURE_DEV_CONNECTION_STRING: ${{ secrets.AIO_AZURE_DEV_CONNECTION_STRING }}
+
+  build:
+    defaults:
+      run:
+        shell: bash
+    needs: [set-state, pre-build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+          cache-dependency-path: 'yarn.lock'
+
+      - name: Enable Corepack for Yarn
+        run: corepack enable
+
+      - name: Install Dependencies
+        run: yarn install
+        env:
+          YARN_ENABLE_IMMUTABLE_INSTALLS: false
+
+      - name: Gatsby Cache
+        uses: actions/[email protected]
+        with:
+          path: |
+            public
+            .cache
+          key: ${{ needs.set-state.outputs.branch_short_ref }}-gatsby-cache-${{ github.run_id }}
+          restore-keys: |
+            ${{ needs.set-state.outputs.branch_short_ref }}-gatsby-cache-
+
+      - name: Clean Cache
+        if: needs.set-state.outputs.clean_cache == 'true'
+        run: yarn clean
+
+      - name: Build site
+        run: yarn build
+        env:
+          PREFIX_PATHS: true # equivalent to --prefix-paths flag for 'gatsby build'
+          PATH_PREFIX: ${{ needs.set-state.outputs.path_prefix }}
+          GATSBY_ADOBE_LAUNCH_SRC: ${{ secrets.AIO_ADOBE_LAUNCH_DEV_SRC }}
+          GATSBY_ADDITIONAL_ADOBE_ANALYTICS_ACCOUNTS: ${{ secrets.AIO_REPORT_SUITE_DEV}}
+          GATSBY_ADOBE_ANALYTICS_ENV: 'dev'
+          REPO_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          REPO_OWNER: ${{ github.event.repository.owner.login }}
+          REPO_NAME: ${{ github.event.repository.name }}
+          REPO_BRANCH: ${{ needs.set-state.outputs.branch_short_ref }}
+          GOOGLE_OAUTH_CLIENT_ID: ${{ secrets.GOOGLE_OAUTH_CLIENT_ID }}
+          GOOGLE_OAUTH_CLIENT_SECRET: ${{ secrets.GOOGLE_OAUTH_CLIENT_SECRET }}
+          GOOGLE_DOCS_TOKEN: ${{ secrets.GOOGLE_DOCS_TOKEN }}
+          GOOGLE_DOCS_FOLDER_ID: ${{ secrets.GOOGLE_DOCS_FOLDER_ID }}
+          GATSBY_IMS_SRC: ${{ secrets.AIO_IMS_DEV_SRC }}
+          GATSBY_IMS_CONFIG: ${{ secrets.AIO_IMS_DEV_CONFIG }}
+          GATSBY_ALGOLIA_APPLICATION_ID: ${{ secrets.AIO_ALGOLIA_APPLICATION_ID }}
+          GATSBY_ALGOLIA_SEARCH_API_KEY: ${{ secrets.AIO_ALGOLIA_SEARCH_API_KEY }}
+          ALGOLIA_INDEXATION_MODE: skip
+          GATSBY_ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME || github.event.repository.name }}
+          GATSBY_FEDS_PRIVACY_ID: ${{ secrets.AIO_FEDS_PRIVACY_ID }}
+          GATSBY_SITE_DOMAIN_URL: https://developer-stage.adobe.com
+
+      - name: Deploy
+        uses: AdobeDocs/static-website-deploy@master
+        with:
+          enabled-static-website: 'true'
+          source: 'public'
+          target: ${{ needs.set-state.outputs.path_prefix }}
+          connection-string: ${{ secrets.AIO_AZURE_DEV_CONNECTION_STRING }}
+          remove-existing-files: 'true'
+          exclude-subfolder: ${{ needs.set-state.outputs.exclude_subfolder }}
+      - name: Purge Fastly Cache
+        uses: AdobeDocs/gatsby-fastly-purge-action@master
+        with:
+          fastly-token: ${{ secrets.AIO_FASTLY_TOKEN }}
+          fastly-url: '${{ secrets.AIO_FASTLY_DEV_URL}}${{ needs.set-state.outputs.path_prefix }}'
diff --git a/.github/workflows/test-pull-request.yml b/.github/workflows/test-pull-request.yml
@@ -61,22 +61,8 @@ jobs:
           DEFAULT_BRANCH: main
           VALIDATE_ALL_CODEBASE: false
           VALIDATE_GITHUB_ACTIONS: true
-      - name: Setup Node v16
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: 'yarn'
-          cache-dependency-path: 'yarn.lock'
-
-      - name: Enable Corepack for Yarn
-        run: corepack enable
-
-      - name: Install Dependencies
-        run: yarn install
-        env:
-          YARN_ENABLE_IMMUTABLE_INSTALLS: false
 
-      - name: Setup Node v16
+      - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
@@ -90,7 +76,6 @@ jobs:
         run: yarn install
         env:
           YARN_ENABLE_IMMUTABLE_INSTALLS: false
-
 
       - name: Check links
         run: yarn test

diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "serve": "NODE_OPTIONS='--max-old-space-size=8192' gatsby serve",
     "clean": "gatsby clean",
     "test": "remark src/pages --quiet --frail",
-    "lint": "docker run --rm -e RUN_LOCAL=true --env-file .github/super-linter.env -v \"$PWD\":/tmp/lint github/super-linter:slim-v4.10.1"
+    "lint": "docker run --rm -e RUN_LOCAL=true --env-file .github/super-linter.env -v \"$PWD\":/tmp/lint github/super-linter:slim-v5"
   },
   "packageManager": "[email protected]"
 }