From 3c3df9305ea0c33ca41f4830ad0b47c0d2cf8b1d Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Mon, 4 Aug 2025 17:35:21 +0200 Subject: [PATCH 01/10] feat(pm-detect): add a shared workflow that returns node package manager information --- package-manager-detect/CHANGELOG.md | 1 + package-manager-detect/LICENSE | 201 ++++++++++++++++++++++++++++ package-manager-detect/README.md | 68 ++++++++++ package-manager-detect/action.yml | 54 ++++++++ 4 files changed, 324 insertions(+) create mode 100644 package-manager-detect/CHANGELOG.md create mode 100644 package-manager-detect/LICENSE create mode 100644 package-manager-detect/README.md create mode 100644 package-manager-detect/action.yml diff --git a/package-manager-detect/CHANGELOG.md b/package-manager-detect/CHANGELOG.md new file mode 100644 index 00000000..825c32f0 --- /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 00000000..7a2f8dac --- /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 00000000..aff93d6e --- /dev/null +++ b/package-manager-detect/README.md @@ -0,0 +1,68 @@ +# 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 + +## 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: "node-pm" + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: ${{ steps.node-pm.outputs.name }} + + - name: Install dependencies + run: ${{ steps.node-pm.outputs.frozenInstall }} + + - name: Install playwright browsers + run: ${{ steps.node-pm.outputs.exec }} playwright install + + - name: Run tests + run: ${{ steps.node-pm.outputs.run }} test + + - name: Build project + run: ${{ steps.node-pm.outputs.run }} build +``` + + + +## Options + +The following options can be passed to this action: + +- `working-directory`: The working directory to run the action in. + +## Troubleshooting + +### Main stats artifact could not be found + +If you see this warning during bundle size workflow runs it means that the workflow failed to find the github artifact that contains the main branch stats file. The file can be generated by either merging a PR to main, pushing a commit to main, or manually running the workflow with workflow_dispatch. diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml new file mode 100644 index 00000000..886c6f3a --- /dev/null +++ b/package-manager-detect/action.yml @@ -0,0 +1,54 @@ +name: "Package Manager Detect" +description: "Detects the Node.js package manager used in a project" +inputs: + workingDirectory: + description: "The working directory to check" + required: false + default: "." +outputs: + name: + description: "The name of the package manager" + value: ${{ steps.detect-package-manager.outputs.name }} + install: + description: "The install command" + value: ${{ steps.detect-package-manager.outputs.install }} + frozenInstall: + description: "The frozen install command" + value: ${{ steps.detect-package-manager.outputs.frozen-install }} + globalInstall: + description: "The global install command" + value: ${{ steps.detect-package-manager.outputs.global-install }} + run: + description: "The run command" + value: ${{ steps.detect-package-manager.outputs.run }} + exec: + description: "The exec command" + value: ${{ steps.detect-package-manager.outputs.exec }} + +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-directory "$WORKING_DIRECTORY") + + # Parse the JSON and extract individual values + NAME=$(echo "$PM_OUTPUT" | jq -r '.name') + INSTALL=$(echo "$PM_OUTPUT" | jq -r '.install') + FROZEN_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.frozen-install') + GLOBAL_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.global-install') + RUN_CMD=$(echo "$PM_OUTPUT" | jq -r '.run') + EXEC_CMD=$(echo "$PM_OUTPUT" | jq -r '.exec') + + # Set outputs + echo "name=$NAME" >> $GITHUB_OUTPUT + echo "install=$INSTALL" >> $GITHUB_OUTPUT + echo "frozen-install=$FROZEN_INSTALL" >> $GITHUB_OUTPUT + echo "global-install=$GLOBAL_INSTALL" >> $GITHUB_OUTPUT + echo "run=$RUN_CMD" >> $GITHUB_OUTPUT + echo "exec=$EXEC_CMD" >> $GITHUB_OUTPUT + shell: bash + env: + WORKING_DIRECTORY: ${{ inputs.workingDirectory }} From b55f83545472b084dbf66f76f9659c03dffefb4c Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Tue, 5 Aug 2025 11:48:01 +0200 Subject: [PATCH 02/10] fix(pm-detect): fix typo in arg --- package-manager-detect/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index 886c6f3a..887d9b89 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -32,7 +32,7 @@ runs: id: detect-package-manager run: | # Run pm-detect and capture the JSON output - PM_OUTPUT=$(npx -y pm-detect --working-directory "$WORKING_DIRECTORY") + PM_OUTPUT=$(npx -y pm-detect --working-dir "$WORKING_DIRECTORY") # Parse the JSON and extract individual values NAME=$(echo "$PM_OUTPUT" | jq -r '.name') From 0f84f4a48c4f99afd86c3085119eb0b7caee95fb Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Tue, 5 Aug 2025 12:03:05 +0200 Subject: [PATCH 03/10] fix(pm-detect): fix jq commands --- package-manager-detect/action.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index 887d9b89..145025f9 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -37,8 +37,8 @@ runs: # Parse the JSON and extract individual values NAME=$(echo "$PM_OUTPUT" | jq -r '.name') INSTALL=$(echo "$PM_OUTPUT" | jq -r '.install') - FROZEN_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.frozen-install') - GLOBAL_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.global-install') + FROZEN_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["frozen-install"]') + GLOBAL_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["global-install"]') RUN_CMD=$(echo "$PM_OUTPUT" | jq -r '.run') EXEC_CMD=$(echo "$PM_OUTPUT" | jq -r '.exec') From 60f1dd6f485d22e32748ba5f4312bd0cd849b133 Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Tue, 5 Aug 2025 17:20:07 +0200 Subject: [PATCH 04/10] fix(pm-detect): fix casing of input working directory --- package-manager-detect/action.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index 145025f9..0c1bda7e 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -1,7 +1,7 @@ name: "Package Manager Detect" description: "Detects the Node.js package manager used in a project" inputs: - workingDirectory: + working-directory: description: "The working directory to check" required: false default: "." @@ -51,4 +51,4 @@ runs: echo "exec=$EXEC_CMD" >> $GITHUB_OUTPUT shell: bash env: - WORKING_DIRECTORY: ${{ inputs.workingDirectory }} + WORKING_DIRECTORY: ${{ inputs.working-directory }} From 9f808e360ff1fc58fac7eb9b7677f3086c2e8cd8 Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Thu, 28 Aug 2025 14:18:45 +0200 Subject: [PATCH 05/10] feat(pm-detect): add more fields --- package-manager-detect/action.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index 0c1bda7e..a246a02e 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -36,19 +36,31 @@ runs: # 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=$(echo "$PM_OUTPUT" | jq -r '.install') FROZEN_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["frozen-install"]') GLOBAL_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["global-install"]') + UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.uninstall') + GLOBAL_UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.global-uninstall') + UPDATE=$(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=$INSTALL" >> $GITHUB_OUTPUT echo "frozen-install=$FROZEN_INSTALL" >> $GITHUB_OUTPUT echo "global-install=$GLOBAL_INSTALL" >> $GITHUB_OUTPUT + echo "uninstall=$UNINSTALL" >> $GITHUB_OUTPUT + echo "global-uninstall=$GLOBAL_UNINSTALL" >> $GITHUB_OUTPUT + echo "update=$UPDATE" >> $GITHUB_OUTPUT echo "run=$RUN_CMD" >> $GITHUB_OUTPUT echo "exec=$EXEC_CMD" >> $GITHUB_OUTPUT + echo "exec-local=$EXEC_LOCAL_CMD" >> $GITHUB_OUTPUT shell: bash env: WORKING_DIRECTORY: ${{ inputs.working-directory }} From 9f2673159a4beffc3b860d389ae497c1dcf07b46 Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Fri, 29 Aug 2025 11:29:40 +0200 Subject: [PATCH 06/10] fix(pm-detect): fix syntax for global-uninstall --- package-manager-detect/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index a246a02e..089868c4 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -42,7 +42,7 @@ runs: FROZEN_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["frozen-install"]') GLOBAL_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["global-install"]') UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.uninstall') - GLOBAL_UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.global-uninstall') + GLOBAL_UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.["global-uninstall"]') UPDATE=$(echo "$PM_OUTPUT" | jq -r '.update') RUN_CMD=$(echo "$PM_OUTPUT" | jq -r '.run') EXEC_CMD=$(echo "$PM_OUTPUT" | jq -r '.exec') From e76f081390fbfbccae88772bdcd7f364cc69f628 Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Fri, 29 Aug 2025 12:35:30 +0200 Subject: [PATCH 07/10] fix(pm-detect): fix jq syntax for exec-local --- package-manager-detect/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index 089868c4..f71116aa 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -46,7 +46,7 @@ runs: UPDATE=$(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') + EXEC_LOCAL_CMD=$(echo "$PM_OUTPUT" | jq -r '.["exec-local"]') # Set outputs echo "name=$NAME" >> $GITHUB_OUTPUT From 3c212edc45670e8cc3514bfda8cc8e83590a6c7b Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Wed, 3 Sep 2025 12:34:17 +0200 Subject: [PATCH 08/10] feat(pm-detect): add missing values to output --- package-manager-detect/action.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index f71116aa..718e97c8 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -9,6 +9,12 @@ outputs: name: description: "The name of the package manager" value: ${{ steps.detect-package-manager.outputs.name }} + lockFilePath: + description: "The path to the lock file" + value: ${{ steps.detect-package-manager.outputs.lock-file-path }} + agent: + description: "The agent used to install dependencies" + value: ${{ steps.detect-package-manager.outputs.agent }} install: description: "The install command" value: ${{ steps.detect-package-manager.outputs.install }} @@ -18,12 +24,24 @@ outputs: globalInstall: description: "The global install command" value: ${{ steps.detect-package-manager.outputs.global-install }} + uninstall: + description: "The uninstall command" + value: ${{ steps.detect-package-manager.outputs.uninstall }} + globalUninstall: + description: "The global uninstall command" + value: ${{ steps.detect-package-manager.outputs.global-uninstall }} + update: + description: "The update command" + value: ${{ steps.detect-package-manager.outputs.update }} run: description: "The run command" value: ${{ steps.detect-package-manager.outputs.run }} exec: description: "The exec command" value: ${{ steps.detect-package-manager.outputs.exec }} + execLocal: + description: "The exec local command" + value: ${{ steps.detect-package-manager.outputs.exec-local }} runs: using: "composite" From 7a6aeb1c6a8c68f0ffabaea92a9fa701819d686a Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Wed, 10 Sep 2025 17:37:09 +0200 Subject: [PATCH 09/10] refactor(pm-detect): improve naming to make usage easier to understand --- package-manager-detect/README.md | 37 ++++++++----- package-manager-detect/action.yml | 90 +++++++++++++++---------------- 2 files changed, 70 insertions(+), 57 deletions(-) diff --git a/package-manager-detect/README.md b/package-manager-detect/README.md index aff93d6e..dd7edadc 100644 --- a/package-manager-detect/README.md +++ b/package-manager-detect/README.md @@ -6,6 +6,24 @@ This GitHub Action attempts to resolve the Node.js package manager a repo uses a - 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 @@ -32,25 +50,26 @@ jobs: uses: actions/checkout@v4 - uses: grafana/plugin-actions/package-manager-detect@package-manager-detect/v0.0.1 - - id: "node-pm" + - id: packageManager - name: Setup Node.js uses: actions/setup-node@v4 with: node-version: "20" - cache: ${{ steps.node-pm.outputs.name }} + cache: ${{ steps.packageManager.outputs.name }} + cache-dependency-path: ${{ steps.packageManager.outputs.lockFilePath }} - name: Install dependencies - run: ${{ steps.node-pm.outputs.frozenInstall }} + run: ${{ steps.packageManager.outputs.frozenInstallCmd }} - name: Install playwright browsers - run: ${{ steps.node-pm.outputs.exec }} playwright install + run: ${{ steps.packageManager.outputs.execCmd }} playwright install - name: Run tests - run: ${{ steps.node-pm.outputs.run }} test + run: ${{ steps.packageManager.outputs.runCmd }} test - name: Build project - run: ${{ steps.node-pm.outputs.run }} build + run: ${{ steps.packageManager.outputs.runCmd }} build ``` @@ -60,9 +79,3 @@ jobs: The following options can be passed to this action: - `working-directory`: The working directory to run the action in. - -## Troubleshooting - -### Main stats artifact could not be found - -If you see this warning during bundle size workflow runs it means that the workflow failed to find the github artifact that contains the main branch stats file. The file can be generated by either merging a PR to main, pushing a commit to main, or manually running the workflow with workflow_dispatch. diff --git a/package-manager-detect/action.yml b/package-manager-detect/action.yml index 718e97c8..80490536 100644 --- a/package-manager-detect/action.yml +++ b/package-manager-detect/action.yml @@ -7,41 +7,41 @@ inputs: default: "." outputs: name: - description: "The name of the package manager" + 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" + 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" + description: "The agent used to install dependencies (e.g. npm, pnpm, yarn, yarnBerry)" value: ${{ steps.detect-package-manager.outputs.agent }} - install: - description: "The install command" - value: ${{ steps.detect-package-manager.outputs.install }} - frozenInstall: - description: "The frozen install command" - value: ${{ steps.detect-package-manager.outputs.frozen-install }} - globalInstall: - description: "The global install command" - value: ${{ steps.detect-package-manager.outputs.global-install }} - uninstall: - description: "The uninstall command" - value: ${{ steps.detect-package-manager.outputs.uninstall }} - globalUninstall: - description: "The global uninstall command" - value: ${{ steps.detect-package-manager.outputs.global-uninstall }} - update: - description: "The update command" - value: ${{ steps.detect-package-manager.outputs.update }} - run: - description: "The run command" - value: ${{ steps.detect-package-manager.outputs.run }} - exec: - description: "The exec command" - value: ${{ steps.detect-package-manager.outputs.exec }} - execLocal: - description: "The exec local command" - value: ${{ steps.detect-package-manager.outputs.exec-local }} + 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" @@ -56,12 +56,12 @@ runs: NAME=$(echo "$PM_OUTPUT" | jq -r '.name') LOCK_FILE_PATH=$(echo "$PM_OUTPUT" | jq -r '.lockFilePath') AGENT=$(echo "$PM_OUTPUT" | jq -r '.agent') - INSTALL=$(echo "$PM_OUTPUT" | jq -r '.install') - FROZEN_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["frozen-install"]') - GLOBAL_INSTALL=$(echo "$PM_OUTPUT" | jq -r '.["global-install"]') - UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.uninstall') - GLOBAL_UNINSTALL=$(echo "$PM_OUTPUT" | jq -r '.["global-uninstall"]') - UPDATE=$(echo "$PM_OUTPUT" | jq -r '.update') + 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"]') @@ -70,15 +70,15 @@ runs: echo "name=$NAME" >> $GITHUB_OUTPUT echo "lock-file-path=$LOCK_FILE_PATH" >> $GITHUB_OUTPUT echo "agent=$AGENT" >> $GITHUB_OUTPUT - echo "install=$INSTALL" >> $GITHUB_OUTPUT - echo "frozen-install=$FROZEN_INSTALL" >> $GITHUB_OUTPUT - echo "global-install=$GLOBAL_INSTALL" >> $GITHUB_OUTPUT - echo "uninstall=$UNINSTALL" >> $GITHUB_OUTPUT - echo "global-uninstall=$GLOBAL_UNINSTALL" >> $GITHUB_OUTPUT - echo "update=$UPDATE" >> $GITHUB_OUTPUT - echo "run=$RUN_CMD" >> $GITHUB_OUTPUT - echo "exec=$EXEC_CMD" >> $GITHUB_OUTPUT - echo "exec-local=$EXEC_LOCAL_CMD" >> $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 }} From 489104498323ddeddd55251e60459d1ab443acd1 Mon Sep 17 00:00:00 2001 From: Jack Westbrook Date: Wed, 3 Dec 2025 15:32:31 +0100 Subject: [PATCH 10/10] chore(pm-detect): add release please configuration --- .release-please-manifest.json | 1 + package-manager-detect/README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index e7dca43d..64d01157 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -6,6 +6,7 @@ "e2e-version": "1.1.2", "is-compatible": "1.0.2", "package-plugin": "1.0.2", + "package-manager-detect": "1.0.0", "playwright-gh-pages/deploy-report-pages": "1.1.0", "playwright-gh-pages/upload-report-artifacts": "1.0.1", "publish-report": "1.0.2", diff --git a/package-manager-detect/README.md b/package-manager-detect/README.md index dd7edadc..d62dccf4 100644 --- a/package-manager-detect/README.md +++ b/package-manager-detect/README.md @@ -49,7 +49,7 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - uses: grafana/plugin-actions/package-manager-detect@package-manager-detect/v0.0.1 + - uses: grafana/plugin-actions/package-manager-detect@package-manager-detect/v1.0.0 - id: packageManager - name: Setup Node.js