chore: Added updating of docs site with compat table (#2205)

.github/workflows/ci-workflow.yml

@@ -8,43 +8,40 @@ env:
 
 jobs:
   should_run:
+    # We only want the test suites to run when code has changed, or when
+    # a dependency update has occurred.
     runs-on: ubuntu-latest
     permissions:
       pull-requests: read
     outputs:
-      javascript_changed: ${{ steps.filter.output.javascript }}
+      javascript_changed: ${{ steps.filter.outputs.javascript }}
+      deps_changed: ${{ steps.deps.outputs.divergent }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
       - uses: dorny/paths-filter@v3
         id: filter
         with:
           filters: |
             javascript:
-              - '**/*.js'
-              - '**/*.json'
-              - '**/*.mjs'
-              - '**/*.cjs'
-
-  skip_if_release:
-    runs-on: ubuntu-latest
-
-    outputs:
-      should_skip: ${{ steps.skip_check.outputs.should_skip }}
-
-    steps:
-      - id: skip_check
-        uses: fkirc/skip-duplicate-actions@v5
+              - 'api.js'
+              - 'esm-loader.mjs'
+              - 'index.js'
+              - 'stub_api.js'
+              - 'lib/**/*.{js,json,mjs,cjs}'
+              - 'test/**/*.{js,json,mjs,cjs}'
+      - uses: jsumners-nr/gha-node-deps-divergent@643628fe0da51ec025e984c4644f17fd9f9e93f6
+        id: deps
         with:
-          paths_ignore: '["NEWS.md", "changelog.json", "package.json", "package-lock.json"]'
-          skip_after_successful_duplicate: false
-          do_not_skip: '["workflow_dispatch", "pull_request"]'
+          base-sha: ${{ github.base_ref }}
+          current-sha: ${{ github.sha }}
 
   lint:
     needs:
-      - skip_if_release
       - should_run
-    if: needs.skip_if_release.outputs.should_skip != 'true'
-      || needs.should_run.outputs.javascript_changed == 'true'
+    if: needs.should_run.outputs.javascript_changed == 'true' ||
+      needs.should_run.outputs.deps_changed == 'true'
     runs-on: ubuntu-latest
 
     strategy:
@@ -61,15 +58,12 @@ jobs:
       run: npm install
     - name: Run Linting
       run: npm run lint
-    - name: Inspect Lockfile
-      run: npm run lint:lockfile
 
   ci:
     needs:
-      - skip_if_release
       - should_run
-    if: needs.skip_if_release.outputs.should_skip != 'true'
-      || needs.should_run.outputs.javascript_changed == 'true'
+    if: needs.should_run.outputs.javascript_changed == 'true' ||
+      needs.should_run.outputs.deps_changed == 'true'
     runs-on: ubuntu-latest
 
     strategy:
@@ -90,10 +84,9 @@ jobs:
 
   unit:
     needs:
-      - skip_if_release
       - should_run
-    if: needs.skip_if_release.outputs.should_skip != 'true'
-      || needs.should_run.outputs.javascript_changed == 'true'
+    if: needs.should_run.outputs.javascript_changed == 'true' ||
+      needs.should_run.outputs.deps_changed == 'true'
     runs-on: ubuntu-latest
 
     strategy:
@@ -119,10 +112,9 @@ jobs:
 
   integration:
     needs:
-      - skip_if_release
       - should_run
-    if: needs.skip_if_release.outputs.should_skip != 'true'
-      || needs.should_run.outputs.javascript_changed == 'true'
+    if: needs.should_run.outputs.javascript_changed == 'true' ||
+      needs.should_run.outputs.deps_changed == 'true'
     runs-on: ubuntu-latest
 
     env:
@@ -160,10 +152,9 @@ jobs:
 
   versioned-internal:
     needs:
-      - skip_if_release
       - should_run
-    if: needs.skip_if_release.outputs.should_skip != 'true'
-      || needs.should_run.outputs.javascript_changed == 'true'
+    if: needs.should_run.outputs.javascript_changed == 'true' ||
+      needs.should_run.outputs.deps_changed == 'true'
     runs-on: ${{ github.ref == 'refs/heads/main' && vars.NR_RUNNER || 'ubuntu-latest' }}
 
     strategy:
@@ -211,10 +202,9 @@ jobs:
   # There is no coverage for external as that's tracked in their respective repos
   versioned-external:
     needs:
-      - skip_if_release
       - should_run
-    if: needs.skip_if_release.outputs.should_skip != 'true'
-      || needs.should_run.outputs.javascript_changed == 'true'
+    if: needs.should_run.outputs.javascript_changed == 'true' ||
+      needs.should_run.outputs.deps_changed == 'true'
     runs-on: ${{ github.ref == 'refs/heads/main' && vars.NR_RUNNER || 'ubuntu-latest' }}
 
     strategy:

.github/workflows/compatibility-report.yml

@@ -54,17 +54,59 @@ jobs:
           path: compatibility.md
 
       # Generate the new PR to update the doc in the repo.
-      - run: |
-          git config user.name $GITHUB_ACTOR
-          git config user.email gh-actions-${GITHUB_ACTOR}@github.com
       - run: |
           rm -f status.log
       - uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e
         with:
+          token: ${{ secrets.NODE_AGENT_GH_TOKEN || secrets.GITHUB_TOKEN }}
           title: "docs: Updated compatibility report"
           commit-message: "docs: Updated compatibility report"
           branch: "compatibility-report/auto-update"
           delete-branch: true
           base: main
           labels: "documentation"
 
+  docs:
+    runs-on: ubuntu-latest
+    if:
+      github.event_name == 'push' ||
+      (github.event.workflow_run && github.event.workflow_run.conclusion == 'success') ||
+      (github.event_name == 'workflow_dispatch' &&
+      (inputs.repo_target == 'docs' || inputs.repo_target == 'both'))
+    env:
+      DOCS_TARGET: src/content/docs/apm/agents/nodejs-agent/getting-started/compatibility-requirements-nodejs-agent.mdx
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          path: agent
+      - uses: actions/checkout@v4
+        with:
+          repository: newrelic/docs-website
+          path: docs
+      - uses: jaxxstorm/action-install-gh-release@71d17cb091aa850acb2a1a4cf87258d183eb941b
+        with:
+          repo: newrelic/newrelic-node-versions
+          platform: linux
+          arch: amd64
+          cache: enable
+      - run: |
+          nrversions -v -r agent -R ${DOCS_TARGET} 2>docs-status.log
+
+      # Upload generated artifacts for potential debugging purposes.
+      - uses: actions/upload-artifact@v4
+        with:
+          name: docs-status.log
+          path: docs-status.log
+
+      # Generate the new PR to update the doc in the repo.
+      - run: |
+          rm -f docs-status.log
+      - uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e
+        with:
+          token: ${{ secrets.NODE_AGENT_GH_TOKEN || secrets.GITHUB_TOKEN }}
+          title: "docs: Updated Node.js agent compatibility report"
+          commit-message: "docs: Updated Node.js agent compatibility report"
+          branch: "nodejs-compatibility-report/auto-update"
+          delete-branch: true
+          base: develop
+          labels: "documentation"

package.json

@@ -161,7 +161,6 @@
     "prepare-test": "npm run ssl && npm run docker-env",
     "lint": "eslint ./*.{js,mjs} lib test bin examples",
     "lint:fix": "eslint --fix, ./*.{js,mjs} lib test bin examples",
-    "lint:lockfile": "lockfile-lint --path package-lock.json --type npm --allowed-hosts npm --validate-https --validate-integrity",
     "public-docs": "jsdoc -c ./jsdoc-conf.jsonc && cp examples/shim/*.png out/",
     "publish-docs": "./bin/publish-docs.sh",
     "services": "docker compose up -d --wait",