Check npm Dependencies #411
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-npm-dependencies-task.md | |
| name: Check npm Dependencies | |
| env: | |
| # See: https://github.com/actions/setup-node/#readme | |
| NODE_VERSION: 20.x | |
| # See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows | |
| on: | |
| create: | |
| push: | |
| paths: | |
| - ".github/workflows/check-npm-dependencies-task.ya?ml" | |
| - ".licenses/**" | |
| - ".licensed.json" | |
| - ".licensed.ya?ml" | |
| - "Taskfile.ya?ml" | |
| - "**/.gitmodules" | |
| - "**/package.json" | |
| - "**/package-lock.json" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/check-npm-dependencies-task.ya?ml" | |
| - ".licenses/**" | |
| - ".licensed.json" | |
| - ".licensed.ya?ml" | |
| - "Taskfile.ya?ml" | |
| - "**/.gitmodules" | |
| - "**/package.json" | |
| - "**/package-lock.json" | |
| schedule: | |
| # Run periodically to catch breakage caused by external changes. | |
| - cron: "0 8 * * WED" | |
| workflow_dispatch: | |
| repository_dispatch: | |
| jobs: | |
| run-determination: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| result: ${{ steps.determination.outputs.result }} | |
| steps: | |
| - name: Determine if the rest of the workflow should run | |
| id: determination | |
| run: | | |
| RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" | |
| # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. | |
| if [[ | |
| "${{ github.event_name }}" != "create" || | |
| "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX | |
| ]]; then | |
| # Run the other jobs. | |
| RESULT="true" | |
| else | |
| # There is no need to run the other jobs. | |
| RESULT="false" | |
| fi | |
| echo "result=$RESULT" >> $GITHUB_OUTPUT | |
| check-cache: | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install licensed | |
| uses: jonabc/setup-licensed@v1 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v1 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Update dependencies license metadata cache | |
| run: task --silent general:cache-dep-licenses | |
| - name: Check for outdated cache | |
| id: diff | |
| run: | | |
| git add . | |
| if ! git diff --cached --color --exit-code; then | |
| echo | |
| echo "::error::Dependency license metadata out of sync. See: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-dependencies-task.md#metadata-cache" | |
| exit 1 | |
| fi | |
| # Some might find it convenient to have CI generate the cache rather than setting up for it locally | |
| - name: Upload cache to workflow artifact | |
| if: failure() && steps.diff.outcome == 'failure' | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| if-no-files-found: error | |
| include-hidden-files: true | |
| name: dep-licenses-cache | |
| path: .licenses/ | |
| check-deps: | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install licensed | |
| uses: jonabc/setup-licensed@v1 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v1 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Check for dependencies with unapproved licenses | |
| run: task --silent general:check-dep-licenses |