add TOC and replace npm install with npm ci

Signed-off-by: Andy Wick <andywick@amazon.com>
opensearch-project · Aug 5, 2024 · 2c59109 · 2c59109
1 parent 1217e36
commit 2c59109
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 12 deletions.
diff --git a/.github/workflows/analyze-pr-changes.yml b/.github/workflows/analyze-pr-changes.yml
@@ -57,7 +57,7 @@ jobs:
             -e OPENSEARCH_INITIAL_ADMIN_PASSWORD="$OPENSEARCH_PASSWORD" \
             opensearch-with-api-plugin
           
-          npm install
+          npm ci
           
           npm run dump-cluster-spec -- --opensearch-insecure --output $CLUSTER_SPEC
           
@@ -72,7 +72,7 @@ jobs:
       - name: Build BEFORE Spec
         shell: bash -eo pipefail {0}
         run: |
-          npm install
+          npm ci
           npm run merge -- --source ./spec --output $BEFORE_SPEC
 
       - name: Checkout AFTER Spec
@@ -82,7 +82,7 @@ jobs:
       - name: Build AFTER Spec
         shell: bash -eo pipefail {0}
         run: |
-          npm install
+          npm ci
           npm run merge -- --source ./spec --output $AFTER_SPEC
 
       - name: Calculate Coverage
@@ -216,4 +216,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: pr-comment
-          path: pr-comment.json
+          path: pr-comment.json
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,7 +21,7 @@ jobs:
           node-version: '20'
 
       - name: Build
-        run: npm install && npm run merge
+        run: npm ci && npm run merge
 
       - name: Extract Branch Name
         id: branch

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -25,7 +25,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Lint
         run: npm run lint
diff --git a/.github/workflows/test-spec.yml b/.github/workflows/test-spec.yml
@@ -55,7 +55,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Run OpenSearch Cluster
         working-directory: .github/opensearch-cluster

diff --git a/.github/workflows/test-tools-integ.yml b/.github/workflows/test-tools-integ.yml
@@ -43,7 +43,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Tests
         run: |
@@ -52,4 +52,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4.0.1
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/test-tools-unit.yml b/.github/workflows/test-tools-unit.yml
@@ -33,7 +33,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Tests
         run: |
@@ -42,4 +42,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4.0.1
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/validate-spec.yml b/.github/workflows/validate-spec.yml
@@ -25,7 +25,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Lint Spec
         run: npm run lint:spec
diff --git a/TESTING_GUIDE.md b/TESTING_GUIDE.md
@@ -1,6 +1,9 @@
 <!-- TOC -->
 - [Spec Testing Guide](#spec-testing-guide)
   - [Running Spec Tests Locally](#running-spec-tests-locally)
+  - [Common Errors](#common-errors)
+    - [401 Unauthorized](#401-unauthorized)
+    - [FORBIDDEN/10/cluster create-index blocked (api)](#forbidden10cluster-create-index-blocked-api)
   - [Writing Spec Tests](#writing-spec-tests)
     - [Simple Test Story](#simple-test-story)
     - [Using Output from Previous Chapters](#using-output-from-previous-chapters)