feat(build-workspace-matrix): add 'relative_to_path' argument (#31)

This allows the returned results to be made relative to a particular path, instead of the repository root

build-workspace-matrix/README.md

@@ -20,6 +20,10 @@ A particular workspace to return when the event type is `workflow_dispatch`.
 
 A newline-separated list of globs representing dependencies of each workspace. If any of the dependencies have changed then all workspaces will be returned.
 
+### `relative_to_path`
+
+If provided, results will be relative to the given path
+
 ## Outputs
 
 ### `matrix`
@@ -124,3 +128,4 @@ jobs:
           github-token: ${{secrets.GITHUB_TOKEN}}
           # A matrix with a single value provided by the input is returned
           workflow_dispatch_workspace: ${{ github.event.inputs.workspace }}
+```

build-workspace-matrix/action.yml

@@ -13,6 +13,9 @@ inputs:
   global_dependencies:
     description: "A newline-separated list of globs representing dependencies of each workspace. If any of the dependencies have changed then all workspaces will be returned. Applies only to 'push' and 'pull_request' events."
     required: false
+  relative_to_path:
+    description: "If provided, results will be relative to the given path"
+    required: false
 outputs:
   matrix:
     description: "The matrix object of the shape: { workspace: [] }"

build-workspace-matrix/main.ts

@@ -7,10 +7,16 @@ import * as minimatch from "minimatch";
 
 (async function run() {
   try {
-    const result = await getWorkspaces();
+    let result = await getWorkspaces();
     console.log(
       `Found ${result.length} impacted workspaces: ${result.join(", ")}`
     );
+
+    const relativeToPath = getInput("relative_to_path");
+    if (relativeToPath) {
+      console.log(`Making relative to ${relativeToPath}`);
+      result = result.map(makeRelative(relativeToPath));
+    }
     setOutput("matrix", { workspace: result });
   } catch (error) {
     setFailed(error.message);
@@ -29,7 +35,9 @@ async function getWorkspaces(): Promise<string[]> {
   const workspaceGlobber = await glob.create(workspaceGlobs, {
     implicitDescendants: false,
   });
-  const workspaces = (await workspaceGlobber.glob()).map(makeRelative());
+  const workspaces = (await workspaceGlobber.glob()).map(
+    makeRelative(process.cwd())
+  );
 
   info(`Found matching workspaces: ${workspaces.join(", ")}`);
 
@@ -101,9 +109,8 @@ async function changedFiled(): Promise<string[]> {
   return response.data.files.map((file) => file.filename);
 }
 
-function makeRelative() {
-  const cwd = process.cwd();
+function makeRelative(from: string) {
   return function (path: string) {
-    return relative(cwd, path);
+    return relative(from, path);
   };
 }