|
| 1 | +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-npm-dependencies-task.md |
| 2 | +name: Check npm Dependencies |
| 3 | + |
| 4 | +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows |
| 5 | +on: |
| 6 | + create: |
| 7 | + push: |
| 8 | + paths: |
| 9 | + - ".github/workflows/check-npm-dependencies-task.ya?ml" |
| 10 | + - ".licenses/**" |
| 11 | + - ".licensed.json" |
| 12 | + - ".licensed.ya?ml" |
| 13 | + - "Taskfile.ya?ml" |
| 14 | + - "**/.gitmodules" |
| 15 | + - "**/.npmrc" |
| 16 | + - "**/package.json" |
| 17 | + - "**/package-lock.json" |
| 18 | + pull_request: |
| 19 | + paths: |
| 20 | + - ".github/workflows/check-npm-dependencies-task.ya?ml" |
| 21 | + - ".licenses/**" |
| 22 | + - ".licensed.json" |
| 23 | + - ".licensed.ya?ml" |
| 24 | + - "Taskfile.ya?ml" |
| 25 | + - "**/.gitmodules" |
| 26 | + - "**/.npmrc" |
| 27 | + - "**/package.json" |
| 28 | + - "**/package-lock.json" |
| 29 | + schedule: |
| 30 | + # Run periodically to catch breakage caused by external changes. |
| 31 | + - cron: "0 8 * * WED" |
| 32 | + workflow_dispatch: |
| 33 | + repository_dispatch: |
| 34 | + |
| 35 | +jobs: |
| 36 | + run-determination: |
| 37 | + runs-on: ubuntu-latest |
| 38 | + permissions: {} |
| 39 | + outputs: |
| 40 | + result: ${{ steps.determination.outputs.result }} |
| 41 | + steps: |
| 42 | + - name: Determine if the rest of the workflow should run |
| 43 | + id: determination |
| 44 | + run: | |
| 45 | + RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" |
| 46 | + # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. |
| 47 | + if [[ |
| 48 | + "${{ github.event_name }}" != "create" || |
| 49 | + "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX |
| 50 | + ]]; then |
| 51 | + # Run the other jobs. |
| 52 | + RESULT="true" |
| 53 | + else |
| 54 | + # There is no need to run the other jobs. |
| 55 | + RESULT="false" |
| 56 | + fi |
| 57 | +
|
| 58 | + echo "result=$RESULT" >> $GITHUB_OUTPUT |
| 59 | +
|
| 60 | + check-cache: |
| 61 | + needs: run-determination |
| 62 | + if: needs.run-determination.outputs.result == 'true' |
| 63 | + runs-on: ubuntu-latest |
| 64 | + permissions: |
| 65 | + contents: read |
| 66 | + |
| 67 | + steps: |
| 68 | + - name: Checkout repository |
| 69 | + uses: actions/checkout@v4 |
| 70 | + with: |
| 71 | + submodules: recursive |
| 72 | + |
| 73 | + # This is required to allow jonabc/setup-licensed to install licensed via Ruby gem. |
| 74 | + - name: Install Ruby |
| 75 | + uses: ruby/setup-ruby@v1 |
| 76 | + with: |
| 77 | + ruby-version: ruby # Install latest version |
| 78 | + |
| 79 | + - name: Install licensed |
| 80 | + uses: jonabc/setup-licensed@v1 |
| 81 | + with: |
| 82 | + github_token: ${{ secrets.GITHUB_TOKEN }} |
| 83 | + version: 3.x |
| 84 | + |
| 85 | + - name: Setup Node.js |
| 86 | + uses: actions/setup-node@v4 |
| 87 | + with: |
| 88 | + node-version-file: package.json |
| 89 | + |
| 90 | + - name: Install Task |
| 91 | + uses: arduino/setup-task@v2 |
| 92 | + with: |
| 93 | + repo-token: ${{ secrets.GITHUB_TOKEN }} |
| 94 | + version: 3.x |
| 95 | + |
| 96 | + - name: Update dependencies license metadata cache |
| 97 | + run: task --silent general:cache-dep-licenses |
| 98 | + |
| 99 | + - name: Check for outdated cache |
| 100 | + id: diff |
| 101 | + run: | |
| 102 | + git add . |
| 103 | + if ! git diff --cached --color --exit-code; then |
| 104 | + echo |
| 105 | + 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" |
| 106 | + exit 1 |
| 107 | + fi |
| 108 | +
|
| 109 | + # Some might find it convenient to have CI generate the cache rather than setting up for it locally |
| 110 | + - name: Upload cache to workflow artifact |
| 111 | + if: failure() && steps.diff.outcome == 'failure' |
| 112 | + uses: actions/upload-artifact@v3 |
| 113 | + with: |
| 114 | + if-no-files-found: error |
| 115 | + include-hidden-files: true |
| 116 | + name: dep-licenses-cache |
| 117 | + path: .licenses/ |
| 118 | + |
| 119 | + check-deps: |
| 120 | + needs: run-determination |
| 121 | + if: needs.run-determination.outputs.result == 'true' |
| 122 | + runs-on: ubuntu-latest |
| 123 | + permissions: |
| 124 | + contents: read |
| 125 | + |
| 126 | + steps: |
| 127 | + - name: Checkout repository |
| 128 | + uses: actions/checkout@v4 |
| 129 | + with: |
| 130 | + submodules: recursive |
| 131 | + |
| 132 | + # This is required to allow jonabc/setup-licensed to install licensed via Ruby gem. |
| 133 | + - name: Install Ruby |
| 134 | + uses: ruby/setup-ruby@v1 |
| 135 | + with: |
| 136 | + ruby-version: ruby # Install latest version |
| 137 | + |
| 138 | + - name: Install licensed |
| 139 | + uses: jonabc/setup-licensed@v1 |
| 140 | + with: |
| 141 | + github_token: ${{ secrets.GITHUB_TOKEN }} |
| 142 | + version: 3.x |
| 143 | + |
| 144 | + - name: Setup Node.js |
| 145 | + uses: actions/setup-node@v4 |
| 146 | + with: |
| 147 | + node-version-file: package.json |
| 148 | + |
| 149 | + - name: Install Task |
| 150 | + uses: arduino/setup-task@v2 |
| 151 | + with: |
| 152 | + repo-token: ${{ secrets.GITHUB_TOKEN }} |
| 153 | + version: 3.x |
| 154 | + |
| 155 | + - name: Check for dependencies with unapproved licenses |
| 156 | + run: task --silent general:check-dep-licenses |
0 commit comments