feat: add the wotking-directory input parameter

.github/workflows/ci.yml

@@ -56,13 +56,20 @@ jobs:
         os: ["ubuntu-20.04", "ubuntu-22.04"]
     runs-on: ${{ matrix.os }}
     needs: check-dist
+    env:
+      CODSPEED_SKIP_UPLOAD: true
     steps:
       - uses: actions/checkout@v3
-      - uses: ./
+      - name: Check basic action execution
+        uses: ./
         with:
           run: echo "Working!"
-        env:
-          CODSPEED_SKIP_UPLOAD: true
+      - name: Check action in a custom directory
+        uses: ./
+        with:
+          working-directory: examples
+          # Check that the directory is actually changed
+          run: if [ $(basename $(pwd)) != "examples" ]; then exit 1; fi
 
   tests:
     runs-on: ubuntu-latest

README.md

@@ -24,6 +24,11 @@ GitHub Actions for running [CodSpeed](https://codspeed.io) in your CI.
     # The command used to run your codspeed benchmarks
     run: ""
 
+    # [OPTIONAL]
+    # The directory where the `run` command will be executed.
+    # ⚠️ WARNING: if you use `defaults.run.working-directory`, you must still set this parameter.
+    working-directory: ""
+
     # [OPTIONAL]
     # A custom upload url, only if you are using an on premise CodSpeed instance
     upload_url: ""

action.yml

@@ -12,6 +12,11 @@ inputs:
   run:
     description: "The command to run the benchmarks"
     required: true
+  working-directory:
+    description: |
+      The directory where the `run` command will be executed.
+      Warning: if you use defaults.working-directory, you must still set this parameter.
+    required: false
   upload_url:
     description: "The upload endpoint (for on-premise deployments)"
     default: "https://api.codspeed.io/upload"

src/inputs.ts

@@ -7,6 +7,8 @@ export const getActionInputs = (): ActionInputs => {
   return {
     uploadUrl: core.getInput("upload_url", {required: true}),
     run: core.getInput("run", {required: true}),
+    workingDirectory:
+      core.getInput("working-directory", {required: false}) || undefined,
     token,
     tokenless,
   };

src/interfaces.ts

@@ -2,6 +2,7 @@ export interface ActionInputs {
   token: string;
   uploadUrl: string;
   run: string;
+  workingDirectory: string | undefined;
   tokenless: boolean;
 }
 

src/run.ts

@@ -93,6 +93,7 @@ const run = async (inputs: ActionInputs): Promise<{profileFolder: string}> => {
     ].join(" ");
     core.debug(`Running: ${command}`);
     const exitCode = await exec(command, [], {
+      cwd: inputs.workingDirectory,
       env: {
         ...process.env,
         // prepend the custom dist/bin folder to the path, to run our custom node script instead of the regular node