diff --git a/package-manager-detect/CHANGELOG.md b/package-manager-detect/CHANGELOG.md new file mode 100644 index 0000000..825c32f --- /dev/null +++ b/package-manager-detect/CHANGELOG.md @@ -0,0 +1 @@ +# Changelog diff --git a/package-manager-detect/LICENSE b/package-manager-detect/LICENSE new file mode 100644 index 0000000..7a2f8da --- /dev/null +++ b/package-manager-detect/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Grafana Labs + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/package-manager-detect/README.md b/package-manager-detect/README.md new file mode 100644 index 0000000..dd7edad --- /dev/null +++ b/package-manager-detect/README.md @@ -0,0 +1,81 @@ +# Package manager detect action + +This GitHub Action attempts to resolve the Node.js package manager a repo uses and returns a normalised map of commands for subsequent workflow steps to use. + +## Features + +- Detects package manager based on packageManager field then lock file +- If no package.json is found in the current directory it will traverse up directories to the nearest package.json file +- If no lock file is found in the current directory it will traverse up directories to find the nearest lock file + +## Outputs + +This workflow outputs the following information / commands for the node package manager the project uses: + +- `name`: The name of the package manager (e.g. npm, pnpm, yarn) used to install dependencies and run scripts. +- `agent`: Like name but can be used to know if yarn berry is used by a project. +- `lockFilePath`: The path to the closest lock file (e.g. package-lock.json, pnpm-lock.yaml, yarn.lock). +- `installCmd`: The install command (e.g. npm install, pnpm install, yarn install). +- `frozenInstallCmd`: The install command recommended for CI environments (e.g. npm ci, pnpm install --frozen-lockfile, yarn install --immutable). +- `globalInstallCmd`: The global install command (e.g. npm install -g, pnpm install -g, yarn global add). +- `uninstallCmd`: The uninstall command (e.g. npm uninstall, pnpm remove, yarn remove). +- `globalUninstallCmd`: The global uninstall command (e.g. npm uninstall -g, pnpm remove -g, yarn global remove). +- `updateCmd`: The update command (e.g. npm update, pnpm update, yarn upgrade). +- `runCmd`: The run command (e.g. npm run, pnpm run, yarn run). +- `execCmd`: The exec command (e.g. npx, pnpm dlx, yarn dlx). +- `execLocalCmd`: The exec command (e.g. npx, pnpm dlx, yarn exec). + +## Usage + +- Add a workflow to your Github repository as in the example below. + +## Workflow example + + + +```yaml +name: Run CI + +on: + pull_request: + branches: + - main + +jobs: + compare: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - uses: grafana/plugin-actions/package-manager-detect@package-manager-detect/v0.0.1 + - id: packageManager + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: ${{ steps.packageManager.outputs.name }} + cache-dependency-path: ${{ steps.packageManager.outputs.lockFilePath }} + + - name: Install dependencies + run: ${{ steps.packageManager.outputs.frozenInstallCmd }} + + - name: Install playwright browsers + run: ${{ steps.packageManager.outputs.execCmd }} playwright install + + - name: Run tests + run: ${{ steps.packageManager.outputs.runCmd }} test + + - name: Build project + run: ${{ steps.packageManager.outputs.runCmd }} build +``` + + + +## Options + +The following options can be passed to this action: + +- `working-directory`: The working directory to run the action in. diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml new file mode 100644 index 0000000..8049053 --- /dev/null +++ b/package-manager-detect/action.yml @@ -0,0 +1,84 @@ +name: "Package Manager Detect" +description: "Detects the Node.js package manager used in a project" +inputs: + working-directory: + description: "The working directory to check" + required: false + default: "." +outputs: + name: + description: "The name of the package manager (e.g. npm, pnpm, yarn)" + value: ${{ steps.detect-package-manager.outputs.name }} + lockFilePath: + description: "The path to the lock file (e.g. package-lock.json, pnpm-lock.yaml, yarn.lock)" + value: ${{ steps.detect-package-manager.outputs.lock-file-path }} + agent: + description: "The agent used to install dependencies (e.g. npm, pnpm, yarn, yarnBerry)" + value: ${{ steps.detect-package-manager.outputs.agent }} + installCmd: + description: "The install command (e.g. npm install, pnpm install, yarn install)" + value: ${{ steps.detect-package-manager.outputs.install-cmd }} + frozenInstallCmd: + description: "The frozen install command (e.g. npm ci, pnpm install --immutable, yarn install --immutable)" + value: ${{ steps.detect-package-manager.outputs.frozen-install-cmd }} + globalInstallCmd: + description: "The global install command (e.g. npm install -g, pnpm install -g, yarn global add)" + value: ${{ steps.detect-package-manager.outputs.global-install-cmd }} + uninstallCmd: + description: "The uninstall command (e.g. npm uninstall, pnpm uninstall, yarn remove)" + value: ${{ steps.detect-package-manager.outputs.uninstall-cmd }} + globalUninstallCmd: + description: "The global uninstall command (e.g. npm uninstall -g, pnpm uninstall -g, yarn global remove)" + value: ${{ steps.detect-package-manager.outputs.global-uninstall-cmd }} + updateCmd: + description: "The update command (e.g. npm update, pnpm update, yarn upgrade)" + value: ${{ steps.detect-package-manager.outputs.update-cmd }} + runCmd: + description: "The run command (e.g. npm run, pnpm run, yarn run)" + value: ${{ steps.detect-package-manager.outputs.run-cmd }} + execCmd: + description: "The exec command (e.g. npx, pnpm dlx, yarn dlx)" + value: ${{ steps.detect-package-manager.outputs.exec-cmd }} + execLocalCmd: + description: "The exec local command (e.g. npx, pnpm dlx, yarn dlx)" + value: ${{ steps.detect-package-manager.outputs.exec-local-cmd }} + +runs: + using: "composite" + steps: + - name: Detect package manager + id: detect-package-manager + run: | + # Run pm-detect and capture the JSON output + PM_OUTPUT=$(npx -y pm-detect --working-dir "$WORKING_DIRECTORY") + + # Parse the JSON and extract individual values + NAME=$(echo "$PM_OUTPUT" | jq -r '.name') + LOCK_FILE_PATH=$(echo "$PM_OUTPUT" | jq -r '.lockFilePath') + AGENT=$(echo "$PM_OUTPUT" | jq -r '.agent') + INSTALL_CMD=$(echo "$PM_OUTPUT" | jq -r '.install') + UNINSTALL_CMD=$(echo "$PM_OUTPUT" | jq -r '.uninstall') + FROZEN_INSTALL_CMD=$(echo "$PM_OUTPUT" | jq -r '.["frozen-install"]') + GLOBAL_INSTALL_CMD=$(echo "$PM_OUTPUT" | jq -r '.["global-install"]') + GLOBAL_UNINSTALL_CMD=$(echo "$PM_OUTPUT" | jq -r '.["global-uninstall"]') + UPDATE_CMD=$(echo "$PM_OUTPUT" | jq -r '.update') + RUN_CMD=$(echo "$PM_OUTPUT" | jq -r '.run') + EXEC_CMD=$(echo "$PM_OUTPUT" | jq -r '.exec') + EXEC_LOCAL_CMD=$(echo "$PM_OUTPUT" | jq -r '.["exec-local"]') + + # Set outputs + echo "name=$NAME" >> $GITHUB_OUTPUT + echo "lock-file-path=$LOCK_FILE_PATH" >> $GITHUB_OUTPUT + echo "agent=$AGENT" >> $GITHUB_OUTPUT + echo "install-cmd=$INSTALL_CMD" >> $GITHUB_OUTPUT + echo "uninstall-cmd=$UNINSTALL_CMD" >> $GITHUB_OUTPUT + echo "frozen-install-cmd=$FROZEN_INSTALL_CMD" >> $GITHUB_OUTPUT + echo "global-install-cmd=$GLOBAL_INSTALL_CMD" >> $GITHUB_OUTPUT + echo "global-uninstall-cmd=$GLOBAL_UNINSTALL_CMD" >> $GITHUB_OUTPUT + echo "update-cmd=$UPDATE_CMD" >> $GITHUB_OUTPUT + echo "run-cmd=$RUN_CMD" >> $GITHUB_OUTPUT + echo "exec-cmd=$EXEC_CMD" >> $GITHUB_OUTPUT + echo "exec-local-cmd=$EXEC_LOCAL_CMD" >> $GITHUB_OUTPUT + shell: bash + env: + WORKING_DIRECTORY: ${{ inputs.working-directory }}