feat: add names to all jobs and steps

.github/workflows/audit.yml

@@ -10,19 +10,25 @@ on:
 
 jobs:
  audit:
+ name: Audit
  if: github.repository_owner == 'npm'
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v3
- - name: Setup git user
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Git User
  run: |
  git config --global user.email "npm-cli+bot@github.com"
  git config --global user.name "npm CLI robot"
- - uses: actions/setup-node@v3
+ - name: Setup Node
+ uses: actions/setup-node@v3
  with:
  node-version: 18.x
- - name: Update npm to latest
+ - name: Install npm@latest
  run: npm i --prefer-online --no-fund --no-audit -g npm@latest
- - run: npm -v
- - run: npm i --ignore-scripts --no-audit --no-fund --package-lock
- - run: npm audit
+ - name: npm Version
+ run: npm -v
+ - name: Install Dependencies
+ run: npm i --ignore-scripts --no-audit --no-fund --package-lock
+ - name: Run Audit
+ run: npm audit

.github/workflows/ci-release.yml

@@ -0,0 +1,104 @@
+# This file is automatically added by @npmcli/template-oss. Do not edit.
+
+name: CI - Release
+
+on:
+ workflow_call:
+ inputs:
+ ref:
+ required: true
+ type: string
+
+jobs:
+ lint-all:
+ name: Lint All
+ if: github.repository_owner == 'npm'
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ ref: ${{ inputs.ref }}
+ - name: Setup Git User
+ run: |
+ git config --global user.email "npm-cli+bot@github.com"
+ git config --global user.name "npm CLI robot"
+ - name: Setup Node
+ uses: actions/setup-node@v3
+ with:
+ node-version: 18.x
+ - name: Install npm@latest
+ run: npm i --prefer-online --no-fund --no-audit -g npm@latest
+ - name: npm Version
+ run: npm -v
+ - name: Install Dependencies
+ run: npm i --ignore-scripts --no-audit --no-fund
+ - name: Lint
+ run: npm run lint --ignore-scripts
+ - name: Post Lint
+ run: npm run postlint --ignore-scripts
+
+ test-all:
+ name: Test All - ${{ matrix.platform.name }} - Node ${{ matrix.node-version }}
+ if: github.repository_owner == 'npm'
+ strategy:
+ fail-fast: false
+ matrix:
+ platform:
+ - name: Linux
+ os: ubuntu-latest
+ shell: bash
+ - name: macOS
+ os: macos-latest
+ shell: bash
+ - name: Windows
+ os: windows-latest
+ shell: cmd
+ node-version:
+ - 14.17.0
+ - 14.x
+ - 16.13.0
+ - 16.x
+ - 18.0.0
+ - 18.x
+ runs-on: ${{ matrix.platform.os }}
+ defaults:
+ run:
+ shell: ${{ matrix.platform.shell }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ ref: ${{ inputs.ref }}
+ - name: Setup Git User
+ run: |
+ git config --global user.email "npm-cli+bot@github.com"
+ git config --global user.name "npm CLI robot"
+ - name: Setup Node
+ uses: actions/setup-node@v3
+ with:
+ node-version: ${{ matrix.node-version }}
+ - name: Update Windows npm
+ # node 12 and 14 ship with npm@6, which is known to fail when updating itself in windows
+ if: matrix.platform.os == 'windows-latest' && (startsWith(matrix.node-version, '12.') || startsWith(matrix.node-version, '14.'))
+ run: |
+ curl -sO https://registry.npmjs.org/npm/-/npm-7.5.4.tgz
+ tar xf npm-7.5.4.tgz
+ cd package
+ node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
+ cd ..
+ rmdir /s /q package
+ - name: Install npm@7
+ if: startsWith(matrix.node-version, '10.')
+ run: npm i --prefer-online --no-fund --no-audit -g npm@7
+ - name: Install npm@latest
+ if: ${{ !startsWith(matrix.node-version, '10.') }}
+ run: npm i --prefer-online --no-fund --no-audit -g npm@latest
+ - name: npm Version
+ run: npm -v
+ - name: Install Dependencies
+ run: npm i --ignore-scripts --no-audit --no-fund
+ - name: Add Problem Matcher
+ run: echo "::add-matcher::.github/matchers/tap.json"
+ - name: Test
+ run: npm test --ignore-scripts -ws -iwr --if-present

.github/workflows/ci.yml

@@ -15,56 +15,70 @@ on:
 
 jobs:
  lint:
+ name: Lint
  if: github.repository_owner == 'npm'
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v3
- - name: Setup git user
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Git User
  run: |
  git config --global user.email "npm-cli+bot@github.com"
  git config --global user.name "npm CLI robot"
- - uses: actions/setup-node@v3
+ - name: Setup Node
+ uses: actions/setup-node@v3
  with:
  node-version: 18.x
- - name: Update npm to latest
+ - name: Install npm@latest
  run: npm i --prefer-online --no-fund --no-audit -g npm@latest
- - run: npm -v
- - run: npm i --ignore-scripts --no-audit --no-fund
- - run: npm run lint
+ - name: npm Version
+ run: npm -v
+ - name: Install Dependencies
+ run: npm i --ignore-scripts --no-audit --no-fund
+ - name: Lint
+ run: npm run lint --ignore-scripts
+ - name: Post Lint
+ run: npm run postlint --ignore-scripts
 
  test:
+ name: Test - ${{ matrix.platform.name }} - Node ${{ matrix.node-version }}
  if: github.repository_owner == 'npm'
  strategy:
  fail-fast: false
  matrix:
+ platform:
+ - name: Linux
+ os: ubuntu-latest
+ shell: bash
+ - name: macOS
+ os: macos-latest
+ shell: bash
+ - name: Windows
+ os: windows-latest
+ shell: cmd
  node-version:
  - 14.17.0
  - 14.x
  - 16.13.0
  - 16.x
  - 18.0.0
  - 18.x
- platform:
- - os: ubuntu-latest
- shell: bash
- - os: macos-latest
- shell: bash
- - os: windows-latest
- shell: cmd
  runs-on: ${{ matrix.platform.os }}
  defaults:
  run:
  shell: ${{ matrix.platform.shell }}
  steps:
- - uses: actions/checkout@v3
- - name: Setup git user
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Git User
  run: |
  git config --global user.email "npm-cli+bot@github.com"
  git config --global user.name "npm CLI robot"
- - uses: actions/setup-node@v3
+ - name: Setup Node
+ uses: actions/setup-node@v3
  with:
  node-version: ${{ matrix.node-version }}
- - name: Update to workable npm (windows)
+ - name: Update Windows npm
  # node 12 and 14 ship with npm@6, which is known to fail when updating itself in windows
  if: matrix.platform.os == 'windows-latest' && (startsWith(matrix.node-version, '12.') || startsWith(matrix.node-version, '14.'))
  run: |
@@ -74,15 +88,17 @@ jobs:
  node lib/npm.js install --no-fund --no-audit -g ..\npm-7.5.4.tgz
  cd ..
  rmdir /s /q package
- - name: Update npm to 7
- # If we do test on npm 10 it needs npm7
+ - name: Install npm@7
  if: startsWith(matrix.node-version, '10.')
  run: npm i --prefer-online --no-fund --no-audit -g npm@7
- - name: Update npm to latest
+ - name: Install npm@latest
  if: ${{ !startsWith(matrix.node-version, '10.') }}
  run: npm i --prefer-online --no-fund --no-audit -g npm@latest
- - run: npm -v
- - run: npm i --ignore-scripts --no-audit --no-fund
- - name: add tap problem matcher
+ - name: npm Version
+ run: npm -v
+ - name: Install Dependencies
+ run: npm i --ignore-scripts --no-audit --no-fund
+ - name: Add Problem Matcher
  run: echo "::add-matcher::.github/matchers/tap.json"
- - run: npm test --ignore-scripts
+ - name: Test
+ run: npm test --ignore-scripts -iwr

.github/workflows/codeql-analysis.yml

@@ -24,8 +24,9 @@ jobs:
  contents: read
  security-events: write
  steps:
- - uses: actions/checkout@v3
- - name: Setup git user
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Git User
  run: |
  git config --global user.email "npm-cli+bot@github.com"
  git config --global user.name "npm CLI robot"

.github/workflows/post-dependabot.yml

@@ -1,57 +1,67 @@
 # This file is automatically added by @npmcli/template-oss. Do not edit.
 
-name: Post Dependabot Actions
+name: Post Dependabot
 
 on: pull_request
 
 permissions:
  contents: write
 
 jobs:
- template-oss-apply:
+ template-oss:
+ name: "@npmcli/template-oss"
  if: github.repository_owner == 'npm' && github.actor == 'dependabot[bot]'
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v3
+ - name: Checkout
+ uses: actions/checkout@v3
  with:
  ref: ${{ github.event.pull_request.head_ref }}
- - name: Setup git user
+ - name: Setup Git User
  run: |
  git config --global user.email "npm-cli+bot@github.com"
  git config --global user.name "npm CLI robot"
- - uses: actions/setup-node@v3
+ - name: Setup Node
+ uses: actions/setup-node@v3
  with:
  node-version: 18.x
- - name: Update npm to latest
+ - name: Install npm@latest
  run: npm i --prefer-online --no-fund --no-audit -g npm@latest
- - run: npm -v
- - run: npm i --ignore-scripts --no-audit --no-fund
- - name: Dependabot metadata
+ - name: npm Version
+ run: npm -v
+ - name: Install Dependencies
+ run: npm i --ignore-scripts --no-audit --no-fund
+ - name: Fetch Dependabot Metadata
  id: metadata
  uses: dependabot/fetch-metadata@v1
  with:
  github-token: ${{ secrets.GITHUB_TOKEN }}
 
- - name: Get command flags
+ # Dependabot can update multiple directories so we output which directory
+ # it is acting on so we can run the command for the correct root or workspace
+ - name: Get Dependabot Directory
  if: contains(steps.metadata.outputs.dependency-names, '@npmcli/template-oss')
  id: flags
  run: |
- if [[ "${{steps.metadata.outputs.directory}}" == "/" ]]; then
+ if [[ "${{ steps.metadata.outputs.directory }}" == "/" ]]; then
  echo "::set-output name=workspace::-iwr"
  else
  echo "::set-output name=workspace::-w ${{ steps.metadata.outputs.directory }}"
  fi
 
- - name: Apply changes
+ - name: Apply Changes
  if: steps.flags.outputs.workspace
  id: apply
  run: |
- npm run template-oss-apply ${{steps.flags.outputs.workspace}}
+ npm run template-oss-apply ${{ steps.flags.outputs.workspace }}
  if [[ `git status --porcelain` ]]; then
  echo "::set-output name=changes::true"
  fi
 
- - name: Push all changes
+ # This step will fail if template-oss has made any workflow updates. It is impossible
+ # for a workflow to update other workflows. In the case it does fail, we continue
+ # and then try to apply only a portion of the changes in the next step
+ - name: Push All Changes
  if: steps.apply.outputs.changes
  id: push
  continue-on-error: true
@@ -61,7 +71,7 @@ jobs:
  git commit -am "chore: postinstall for dependabot template-oss PR"
  git push
 
- - name: Push all except workflows
+ - name: Push All Changes Except Workflows
  if: steps.push.outcome == 'failure'
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -72,7 +82,7 @@ jobs:
  git commit -am "chore: postinstall for dependabot template-oss PR"
  git push
 
- - name: Verify changes
+ - name: Check Changes
  if: steps.apply.outputs.changes
  run: |
- npm exec --offline ${{steps.flags.outputs.workspace}} -- template-oss-check
+ npm exec --offline ${{ steps.flags.outputs.workspace }} -- template-oss-check