chore: do not check in lockfiles but cache them (#1896)

.github/workflows/canary.yaml

@@ -6,7 +6,7 @@ on:
       - main
 
 jobs:
-  build-and-test:
+  build-and-deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
@@ -23,21 +23,34 @@ jobs:
           registry-url: https://registry.npmjs.org
           scope: '@opentelemetry'
 
-      - name: restore lerna
+      - name: restore lock files
         uses: actions/cache@master # must use unreleased master to cache multiple paths
         id: cache
         with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
           path: |
-            node_modules
-            packages/*/node_modules
-            metapackages/*/node_modules
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
           key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
 
-      - name: Install and Build 🔧
+      - name: Install root dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Install and Build (cache miss) 🔧
         if: steps.cache.outputs.cache-hit != 'true'
         run: |
-          npm ci --ignore-scripts
+          npx lerna bootstrap --no-ci
+          npm run compile
+
+      - name: Install and Build (cache hit) 🔧
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: |
           npx lerna bootstrap
+          npm run compile
 
       - name: Publish
         run: npx lerna publish --canary --yes

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Deploy docs on a new release
+name: Deploy API Documentation
 
 on:
   release:
@@ -11,10 +11,30 @@ jobs:
       - name: Checkout 🛎️
         uses: actions/checkout@v2
 
-      - name: Install Dependencies
-        run: |
-          npm ci --ignore-scripts
-          npx lerna bootstrap --scope @opentelemetry/api --include-dependencies
+      - name: restore lock files
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
+          path: |
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
+          key: ${{ runner.os }}-docs-${{ hashFiles('**/package.json') }}
+
+      - name: Install root dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Install and Build (cache miss) 🔧
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npx lerna bootstrap --no-ci --scope @opentelemetry/api --include-dependencies
+
+      - name: Install and Build (cache hit) 🔧
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: npx lerna bootstrap --scope @opentelemetry/api --include-dependencies
 
       - name: Build 🔧
         run: |

.github/workflows/lint.yml

@@ -28,20 +28,46 @@ jobs:
         with:
           args: "./**/*.md -i ./CHANGELOG.md"
 
-      - name: Bootstrap
+      - name: restore lock files
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
+          path: |
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
+          key: ${{ runner.os }}-lint-${{ hashFiles('**/package.json') }}
+
+      - name: Install root dependencies
+        run: npm ci --ignore-scripts
+
+      # On a cache hit, use ci to speed up the install process
+      - name: Bootstrap (cache hit)
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: npx lerna bootstrap --ignore-scripts
+
+      # On a cache miss, fall back to a regular install
+      - name: Bootstrap (cache miss)
         if: steps.cache.outputs.cache-hit != 'true'
-        run: |
-          npm ci --ignore-scripts
-          npx lerna bootstrap --ignore-scripts
+        run: npx lerna bootstrap --no-ci --ignore-scripts -- --only=dev
 
       - name: Lint
         run: |
           npm run lint
           npm run lint:examples
 
-      - name: Install API Dependencies
+      - name: Install API Dependencies (cache hit)
+        if: steps.cache.outputs.cache-hit == 'true'
         run: npx lerna bootstrap --scope @opentelemetry/api --include-dependencies
 
+      - name: Install API Dependencies (cache miss)
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npx lerna bootstrap --no-ci --scope @opentelemetry/api --include-dependencies
+
       - name: Build 🔧
         run: |
           npx lerna run compile --scope @opentelemetry/api

.github/workflows/unit-test.yml

@@ -19,12 +19,36 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v1
-      - name: Install Root Dependencies
+
+      - name: restore lock files
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
+          path: |
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
+          key: ${{ runner.os }}-unit_test-${{ matrix.container }}-${{ hashFiles('**/package.json') }}
+
+      - name: Install root dependencies
         run: npm ci --ignore-scripts
-      - name: Boostrap Dependencies
-        run: npx lerna bootstrap
-      - name: Build
-        run: npm run compile
+
+      - name: Install and Build (cache miss) 🔧
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          npx lerna bootstrap --no-ci
+          npm run compile
+
+      - name: Install and Build (cache hit) 🔧
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: |
+          npx lerna bootstrap
+          npm run compile
+
       - name: Unit tests
         run: npm run test
       - name: Report Coverage
@@ -41,12 +65,36 @@ jobs:
         uses: actions/checkout@v1
       - name: Permission Setup
         run: sudo chmod -R 777 /github /__w
-      - name: Install Root Dependencies
+
+      - name: restore lock files
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
+          path: |
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
+          key: ${{ runner.os }}-unit_test-${{ matrix.container }}-${{ hashFiles('**/package.json') }}
+
+      - name: Install root dependencies
         run: npm ci --ignore-scripts
-      - name: Boostrap Dependencies
-        run: npx lerna bootstrap
-      - name: Build
-        run: npm run compile
+
+      - name: Install and Build (cache miss) 🔧
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          npx lerna bootstrap --no-ci
+          npm run compile
+
+      - name: Install and Build (cache hit) 🔧
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: |
+          npx lerna bootstrap
+          npm run compile
+
       - name: Unit tests
         run: npm run test:browser
       - name: Report Coverage

.github/workflows/w3c-integration-test.yml

@@ -1,4 +1,4 @@
-name: Run w3c tests on push
+name: W3C Trace Context Integration Test
 
 on:
   push:
@@ -7,16 +7,36 @@ on:
   pull_request:
 
 jobs:
-  build-and-deploy:
+  build-and-test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v2
 
-      - name: Install
-        run: |
-          npm ci --ignore-scripts
-          npx lerna bootstrap --scope=propagation-validation-server --include-dependencies
+      - name: restore lock files
+        uses: actions/cache@master # must use unreleased master to cache multiple paths
+        id: cache
+        with:
+          # must be done before bootstrap to not include node_modules files in the cache paths
+          path: |
+            packages/*/package-lock.json
+            benchmark/*/package-lock.json
+            backwards-compatability/*/package-lock.json
+            metapackages/*/package-lock.json
+            packages/*/package-lock.json
+            integration-tests/*/package-lock.json
+          key: ${{ runner.os }}-w3c_integration-${{ hashFiles('**/package.json') }}
+
+      - name: Install root dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Install and Build (cache miss) 🔧
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npx lerna bootstrap --no-ci --scope=propagation-validation-server --include-dependencies
+
+      - name: Install and Build (cache hit) 🔧
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: npx lerna bootstrap --scope=propagation-validation-server --include-dependencies
 
       - name: Build 🔧
         run: npm run compile 

.gitignore

@@ -61,6 +61,7 @@ typings/
 # lock files
 yarn.lock
 packages/**/yarn.lock
+*/**/package-lock.json
 
 # docs files
 docs