From fd577378598e04054feaa77dae4597656facce67 Mon Sep 17 00:00:00 2001 From: Nick Alteen Date: Wed, 12 Feb 2025 19:05:13 -0500 Subject: [PATCH] Fix sourcemap and add licensed --- .github/workflows/licensed.yml | 74 ++++++++++++++++++++++ .licensed.yml | 18 ++++++ .licenses/npm/@actions/core.dep.yml | 20 ++++++ .licenses/npm/@actions/exec.dep.yml | 20 ++++++ .licenses/npm/@actions/http-client.dep.yml | 32 ++++++++++ .licenses/npm/@actions/io.dep.yml | 20 ++++++ .licenses/npm/@fastify/busboy.dep.yml | 30 +++++++++ .licenses/npm/tunnel.dep.yml | 35 ++++++++++ .licenses/npm/undici.dep.yml | 34 ++++++++++ .prettierignore | 1 + .yaml-lint.yml | 2 + README.md | 45 +++++++++++++ rollup.config.js | 2 +- 13 files changed, 332 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/licensed.yml create mode 100644 .licensed.yml create mode 100644 .licenses/npm/@actions/core.dep.yml create mode 100644 .licenses/npm/@actions/exec.dep.yml create mode 100644 .licenses/npm/@actions/http-client.dep.yml create mode 100644 .licenses/npm/@actions/io.dep.yml create mode 100644 .licenses/npm/@fastify/busboy.dep.yml create mode 100644 .licenses/npm/tunnel.dep.yml create mode 100644 .licenses/npm/undici.dep.yml diff --git a/.github/workflows/licensed.yml b/.github/workflows/licensed.yml new file mode 100644 index 0000000..e456681 --- /dev/null +++ b/.github/workflows/licensed.yml @@ -0,0 +1,74 @@ +# This workflow checks the statuses of cached dependencies used in this action +# with the help of the Licensed tool. If any licenses are invalid or missing, +# this workflow will fail. See: https://github.com/licensee/licensed + +name: Licensed + +on: + # Uncomment the below lines to run this workflow on pull requests and pushes + # to the default branch. This is useful for checking licenses before merging + # changes into the default branch. + # pull_request: + # branches: + # - main + # push: + # branches: + # - main + workflow_dispatch: + +permissions: + contents: write + +jobs: + licensed: + name: Check Licenses + runs-on: ubuntu-latest + + steps: + - name: Checkout + id: checkout + uses: actions/checkout@v4 + + - name: Setup Node.js + id: setup-node + uses: actions/setup-node@v4 + with: + node-version-file: .node-version + cache: npm + + - name: Install Dependencies + id: npm-ci + run: npm ci + + - name: Setup Ruby + id: setup-ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ruby + + - uses: github/setup-licensed@v1 + with: + version: 4.x + github_token: ${{ secrets.GITHUB_TOKEN }} + + # If this is a workflow_dispatch event, update the cached licenses. + - if: ${{ github.event_name == 'workflow_dispatch' }} + name: Update Licenses + id: update-licenses + run: licensed cache + + # Then, commit the updated licenses to the repository. + - if: ${{ github.event_name == 'workflow_dispatch' }} + name: Commit Licenses + id: commit-licenses + run: | + git config --local user.email "licensed-ci@users.noreply.github.com" + git config --local user.name "licensed-ci" + git add . + git commit -m "Auto-update license files" + git push + + # Last, check the status of the cached licenses. + - name: Check Licenses + id: check-licenses + run: licensed status diff --git a/.licensed.yml b/.licensed.yml new file mode 100644 index 0000000..91239ed --- /dev/null +++ b/.licensed.yml @@ -0,0 +1,18 @@ +# See: https://github.com/licensee/licensed/blob/main/docs/configuration.md + +sources: + npm: true + +allowed: + - apache-2.0 + - bsd-2-clause + - bsd-3-clause + - isc + - mit + - cc0-1.0 + - other + +ignored: + npm: + # Used by Rollup.js when building in GitHub Actions + - '@rollup/rollup-linux-x64-gnu' diff --git a/.licenses/npm/@actions/core.dep.yml b/.licenses/npm/@actions/core.dep.yml new file mode 100644 index 0000000..09e099f --- /dev/null +++ b/.licenses/npm/@actions/core.dep.yml @@ -0,0 +1,20 @@ +--- +name: "@actions/core" +version: 1.11.1 +type: npm +summary: Actions core lib +homepage: https://github.com/actions/toolkit/tree/main/packages/core +license: mit +licenses: +- sources: LICENSE.md + text: |- + The MIT License (MIT) + + Copyright 2019 GitHub + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +notices: [] diff --git a/.licenses/npm/@actions/exec.dep.yml b/.licenses/npm/@actions/exec.dep.yml new file mode 100644 index 0000000..cbc5abd --- /dev/null +++ b/.licenses/npm/@actions/exec.dep.yml @@ -0,0 +1,20 @@ +--- +name: "@actions/exec" +version: 1.1.1 +type: npm +summary: Actions exec lib +homepage: https://github.com/actions/toolkit/tree/main/packages/exec +license: mit +licenses: +- sources: LICENSE.md + text: |- + The MIT License (MIT) + + Copyright 2019 GitHub + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +notices: [] diff --git a/.licenses/npm/@actions/http-client.dep.yml b/.licenses/npm/@actions/http-client.dep.yml new file mode 100644 index 0000000..1ae400a --- /dev/null +++ b/.licenses/npm/@actions/http-client.dep.yml @@ -0,0 +1,32 @@ +--- +name: "@actions/http-client" +version: 2.2.3 +type: npm +summary: Actions Http Client +homepage: https://github.com/actions/toolkit/tree/main/packages/http-client +license: other +licenses: +- sources: LICENSE + text: | + Actions Http Client for Node.js + + Copyright (c) GitHub, Inc. + + All rights reserved. + + MIT License + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and + associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, + subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT + LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN + NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +notices: [] diff --git a/.licenses/npm/@actions/io.dep.yml b/.licenses/npm/@actions/io.dep.yml new file mode 100644 index 0000000..d284654 --- /dev/null +++ b/.licenses/npm/@actions/io.dep.yml @@ -0,0 +1,20 @@ +--- +name: "@actions/io" +version: 1.1.3 +type: npm +summary: Actions io lib +homepage: https://github.com/actions/toolkit/tree/main/packages/io +license: mit +licenses: +- sources: LICENSE.md + text: |- + The MIT License (MIT) + + Copyright 2019 GitHub + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +notices: [] diff --git a/.licenses/npm/@fastify/busboy.dep.yml b/.licenses/npm/@fastify/busboy.dep.yml new file mode 100644 index 0000000..817d644 --- /dev/null +++ b/.licenses/npm/@fastify/busboy.dep.yml @@ -0,0 +1,30 @@ +--- +name: "@fastify/busboy" +version: 2.1.1 +type: npm +summary: A streaming parser for HTML form data for node.js +homepage: +license: mit +licenses: +- sources: LICENSE + text: |- + Copyright Brian White. All rights reserved. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to + deal in the Software without restriction, including without limitation the + rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + IN THE SOFTWARE. +notices: [] diff --git a/.licenses/npm/tunnel.dep.yml b/.licenses/npm/tunnel.dep.yml new file mode 100644 index 0000000..9a7111d --- /dev/null +++ b/.licenses/npm/tunnel.dep.yml @@ -0,0 +1,35 @@ +--- +name: tunnel +version: 0.0.6 +type: npm +summary: Node HTTP/HTTPS Agents for tunneling proxies +homepage: https://github.com/koichik/node-tunnel/ +license: mit +licenses: +- sources: LICENSE + text: | + The MIT License (MIT) + + Copyright (c) 2012 Koichi Kobayashi + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. +- sources: README.md + text: Licensed under the [MIT](https://github.com/koichik/node-tunnel/blob/master/LICENSE) + license. +notices: [] diff --git a/.licenses/npm/undici.dep.yml b/.licenses/npm/undici.dep.yml new file mode 100644 index 0000000..961089c --- /dev/null +++ b/.licenses/npm/undici.dep.yml @@ -0,0 +1,34 @@ +--- +name: undici +version: 5.28.5 +type: npm +summary: An HTTP/1.1 client, written from scratch for Node.js +homepage: https://undici.nodejs.org +license: mit +licenses: +- sources: LICENSE + text: | + MIT License + + Copyright (c) Matteo Collina and Undici contributors + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. +- sources: README.md + text: MIT +notices: [] diff --git a/.prettierignore b/.prettierignore index 60707ac..c6ad5ad 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,5 @@ .DS_Store +.licenses/ dist/ node_modules/ coverage/ diff --git a/.yaml-lint.yml b/.yaml-lint.yml index 8f400a3..f382152 100644 --- a/.yaml-lint.yml +++ b/.yaml-lint.yml @@ -10,3 +10,5 @@ rules: max: 80 allow-non-breakable-words: true allow-non-breakable-inline-mappings: true +ignore: + - .licenses/ diff --git a/README.md b/README.md index 5edf54a..5cedba3 100644 --- a/README.md +++ b/README.md @@ -229,3 +229,48 @@ steps: id: output run: echo "${{ steps.run-action.outputs.time }}" ``` + +## Dependency License Management + +This template includes a GitHub Actions workflow, +[`licensed.yml`](./.github/workflows/licensed.yml), that uses +[Licensed](https://github.com/licensee/licensed) to check for dependencies with +missing or non-compliant licenses. This workflow is initially disabled. To +enable the workflow, follow the below steps. + +1. Open [`licensed.yml`](./.github/workflows/licensed.yml) +1. Uncomment the following lines: + + ```yaml + # pull_request: + # branches: + # - main + # push: + # branches: + # - main + ``` + +1. Save and commit the changes + +Once complete, this workflow will run any time a pull request is created or +changes pushed directly to `main`. If the workflow detects any dependencies with +missing or non-compliant licenses, it will fail the workflow and provide details +on the issue(s) found. + +### Updating Licenses + +Whenever you install or update dependencies, you can use the Licensed CLI to +update the licenses database. To install Licensed, see the project's +[Readme](https://github.com/licensee/licensed?tab=readme-ov-file#installation). + +To update the cached licenses, run the following command: + +```bash +licensed cache +``` + +To check the status of cached licenses, run the following command: + +```bash +licensed status +``` diff --git a/rollup.config.js b/rollup.config.js index 1b55e83..c743e22 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -11,7 +11,7 @@ const config = { format: 'es', sourcemap: true }, - plugins: [commonjs(), nodeResolve()] + plugins: [commonjs(), nodeResolve({ preferBuiltins: true })] } export default config