[feature] Add install script inputs (#85)

* [feature] Add install script inputs

* docs: Add docs for new `install-script` option

Co-authored-by: Alan Orozco <alanorozco@users.noreply.github.com>

* Update action.yml

---------

Co-authored-by: Ryan Christian <rchristian@ryanchristian.dev>
Co-authored-by: Alan Orozco <alanorozco@users.noreply.github.com>
Co-authored-by: Ryan Christian <33403762+rschristian@users.noreply.github.com>

Author: 3 people

README.md

@@ -29,6 +29,26 @@ jobs:
       - uses: preactjs/compressed-size-action@v2
 ```
 
+### Customizing the Installation
+
+By default, `compressed-size-action` will install dependencies according to which lockfiles are present, if any. However, if you need to run a different installation command, you can pass a custom script to do so. For example, to use `npm ci` with the `--workspace` option:
+
+```diff
+name: Compressed Size
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: preactjs/compressed-size-action@v2
+      with:
++       install-script: "npm ci --workspace=packages/my-subpackage"
+```
+
 ### Customizing the Build
 
 By default, `compressed-size-action` will try to build your PR by running the `"build"` [npm script](https://docs.npmjs.com/misc/scripts) in your `package.json`.

action.yml

@@ -11,6 +11,9 @@ inputs:
     default: ${{ github.token }}
   clean-script:
     description: 'An npm-script that cleans/resets state between branch builds'
+  install-script:
+    required: false
+    description: 'Custom installation script to run to set up the dependencies in your project'
   build-script:
     description: 'The npm-script to run that builds your project'
     default: 'build'

index.js

@@ -70,6 +70,10 @@ async function run(octokit, context, token) {
 		installScript = 'npm ci';
 	}
 
+	if (getInput('install-script')) {
+		installScript = getInput('install-script');
+	}
+
 	startGroup(`[current] Install Dependencies`);
 	console.log(`Installing using ${installScript}`);
 	await exec(installScript);
@@ -143,6 +147,10 @@ async function run(octokit, context, token) {
 		installScript = `npm ci`;
 	}
 
+	if (getInput('install-script')) {
+		installScript = getInput('install-script');
+	}
+
 	console.log(`Installing using ${installScript}`);
 	await exec(installScript);
 	endGroup();