feat!: allow to run any script for clean/install/build (#126)

* feat!: allow to run any script for clean/install/build

* docs: change v2 to v3

* chore: revert action.yml prettier changes

* docs: add important note that scripts need to exist in both branches

* docs: fix configs in README

* chore: update microbundle to support Optional chaining

* feat: make install-script optional, some don't need it

* chore: run build

* chore: revert all unrelated changes

* fix: add logs back

* fix: add the required inputs in action workflow

Author: unrevised6419

.github/workflows/ci.yml

@@ -19,4 +19,6 @@ jobs:
         uses: ./
         with:
           repo-token: "${{ secrets.GITHUB_TOKEN }}"
-          pattern: index.js
+          pattern: index.js
+          install-script: npm ci
+          build-script: npm run build

README.md

@@ -2,7 +2,6 @@
 
 A GitHub action that reports changes in compressed file sizes on your PRs.
 
-- Automatically uses `yarn`, `pnpm`, `bun`, `deno`, or `npm ci` when lockfiles are present
 - Builds your PR, then builds the target and compares between the two
 - Doesn't upload anything or rely on centralized storage
 - Supports [custom build scripts](#customizing-the-build) and [file patterns](#customizing-the-list-of-files)
@@ -27,6 +26,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: preactjs/compressed-size-action@v2
+        with:
+          install-script: npm ci
+          build-script: npm run build
+          clean-script: npm run clean
 ```
 
 > **Note:** Due to GitHub's permission model, this action cannot safely create comments when it is triggered by a PR from a fork. It will, however, still generate the size comparison and print the comment it would've posted to the stdout of the action, allowing manual checking and you can copy/paste it into a comment if you wish.
@@ -84,7 +87,7 @@ jobs:
     - uses: actions/checkout@v2
     - uses: preactjs/compressed-size-action@v2
       with:
-+       build-script: "ci"
++       build-script: "npm run build"
 ```
 
 #### Clean up state between builds
@@ -102,7 +105,7 @@ jobs:
     - uses: preactjs/compressed-size-action@v2
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"
-+       clean-script: "clean"
++       clean-script: "npm run clean"
 ```
 
 ```jsonc

action.yml

@@ -13,13 +13,12 @@ inputs:
     description: 'A specific git ref (branch, tag, or SHA) to compare against instead of the PR base branch'
     required: false
   clean-script:
-    description: 'An npm-script that cleans/resets state between branch builds'
+    description: 'A 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'
+    required: true
+    description: 'The script to run that builds your project'
   compression:
     description: 'The compression algorithm to use: "gzip" or "brotli"'
     default: 'gzip'

src/index.js

@@ -2,7 +2,7 @@ import { getInput, setFailed, startGroup, endGroup, debug } from '@actions/core'
 import { context, getOctokit } from '@actions/github';
 import { exec } from '@actions/exec';
 import { SizePlugin } from '@rschristian/size-plugin';
-import { getPackageManagerAndInstallScript, diffTable, toBool, stripHash, getSortOrder } from './utils.js';
+import { diffTable, toBool, stripHash, getSortOrder } from './utils.js';
 
 /**
  * @typedef {ReturnType<typeof import("@actions/github").getOctokit>} Octokit
@@ -54,22 +54,21 @@ async function run(octokit, context, token) {
 		stripHash: stripHash(getInput('strip-hash'))
 	});
 
-	const buildScript = getInput('build-script') || 'build';
+	const buildScript = getInput('build-script', { required: true });
 	const cwd = process.cwd();
 
-	let { packageManager, installScript } = await getPackageManagerAndInstallScript(cwd);
-	if (getInput('install-script')) {
-		installScript = getInput('install-script');
-	}
+	const installScript = getInput('install-script');
 
-	startGroup(`[current] Install Dependencies`);
-	console.log(`Installing using ${installScript}`);
-	await exec(installScript);
-	endGroup();
+	if (installScript) {
+		startGroup(`[current] Install Dependencies`);
+		console.log(`Running install script: "${installScript}"`);
+		await exec(installScript);
+		endGroup();
+	}
 
-	startGroup(`[current] Build using ${packageManager}`);
-	console.log(`Building using ${packageManager} run ${buildScript}`);
-	await exec(`${packageManager} run ${buildScript}`);
+	startGroup(`[current] Building`);
+	console.log(`Running build script: "${buildScript}"`);
+	await exec(buildScript);
 	endGroup();
 
 	const newSizes = await plugin.readFromDisk(cwd);
@@ -103,8 +102,9 @@ async function run(octokit, context, token) {
 
 	const cleanScript = getInput('clean-script');
 	if (cleanScript) {
-		startGroup(`[target] Cleanup via ${packageManager} run ${cleanScript}`);
-		await exec(`${packageManager} run ${cleanScript}`);
+		startGroup(`[target] Cleanup`);
+		console.log(`Running clean script: "${cleanScript}"`);
+		await exec(cleanScript);
 		endGroup();
 	}
 
@@ -118,20 +118,16 @@ async function run(octokit, context, token) {
 	}
 	endGroup();
 
-
-	startGroup(`[base] Install Dependencies`);
-
-	({ packageManager, installScript } = await getPackageManagerAndInstallScript(cwd));
-	if (getInput('install-script')) {
-		installScript = getInput('install-script');
+	if (installScript) {
+		startGroup(`[base] Install Dependencies`);
+		console.log(`Running install script: "${installScript}"`);
+		await exec(installScript);
+		endGroup();
 	}
 
-	console.log(`Installing using ${installScript}`);
-	await exec(installScript);
-	endGroup();
-
-	startGroup(`[base] Build using ${packageManager}`);
-	await exec(`${packageManager} run ${buildScript}`);
+	startGroup(`[base] Building`);
+	console.log(`Running build script: "${buildScript}"`);
+	await exec(buildScript);
 	endGroup();
 
 	// In case the build step alters a JSON-file, ....

src/utils.js

@@ -1,42 +1,6 @@
 import fs from 'fs';
-import path from 'path';
 import prettyBytes from 'pretty-bytes';
 
-/**
- * @param {string} cwd
- * @returns {Promise<{ packageManager: string, installScript: string }>}
- */
-export async function getPackageManagerAndInstallScript(cwd) {
-	const [yarnLockExists, pnpmLockExists, bunLockBinaryExists, bunLockExists, packageLockExists, denoLockExists] = await Promise.all([
-		fileExists(path.resolve(cwd, 'yarn.lock')),
-		fileExists(path.resolve(cwd, 'pnpm-lock.yaml')),
-		fileExists(path.resolve(cwd, 'bun.lockb')),
-		fileExists(path.resolve(cwd, 'bun.lock')),
-		fileExists(path.resolve(cwd, 'package-lock.json')),
-		fileExists(path.resolve(cwd, 'deno.lock')),
-	]);
-
-	let packageManager = 'npm';
-	let installScript = 'npm install';
-	if (yarnLockExists) {
-		installScript = 'yarn --frozen-lockfile';
-		packageManager = 'yarn';
-	} else if (pnpmLockExists) {
-		installScript = 'pnpm install --frozen-lockfile';
-		packageManager = 'pnpm';
-	} else if (bunLockBinaryExists || bunLockExists) {
-		installScript = 'bun install --frozen-lockfile';
-		packageManager = 'bun';
-	} else if (denoLockExists) {
-		installScript = 'deno install --frozen';
-		packageManager = 'deno';
-	} else if (packageLockExists) {
-		installScript = 'npm ci';
-	}
-
-	return { packageManager, installScript };
-}
-
 /**
  * Check if a given file exists and can be accessed.
  * @param {string} filename
@@ -224,7 +188,7 @@ export function diffTable(files, { showTotal, collapseUnchanged, omitUnchanged,
 	}
 
 	let out = '';
-	
+
 	if (changedRows.length !== 0) {
 		const outChanged = markdownTable(changedRows);
 		out = `<details open><summary>📦 <strong>View Changed</strong></summary>\n\n${outChanged}\n\n</details>`;

tests/utils.spec.js

@@ -1,5 +1,4 @@
-import path from 'path';
-import { toBool, getDeltaText, iconForDifference, diffTable, getPackageManagerAndInstallScript, fileExists, stripHash } from '../src/utils.js';
+import { toBool, getDeltaText, iconForDifference, diffTable, fileExists, stripHash } from '../src/utils.js';
 
 test('toBool', () => {
 	expect(toBool('1')).toBe(true);
@@ -76,18 +75,6 @@ test('diffTable', () => {
 	expect(diffTable(files, { ...defaultOptions, sortBy: 'Change:desc' })).toMatchSnapshot();
 });
 
-test('getPackageManagerAndInstallScript', async () => {
-	let cwd = process.cwd();
-	let { packageManager, installScript } = await getPackageManagerAndInstallScript(cwd);
-	expect(packageManager).toBe('npm');
-	expect(installScript).toBe('npm ci');
-
-	cwd = path.join(cwd, 'tests');
-	({ packageManager, installScript } = await getPackageManagerAndInstallScript(cwd));
-	expect(packageManager).toBe('npm');
-	expect(installScript).toBe('npm install');
-});
-
 test('fileExists', async () => {
 	expect(await fileExists('package.json')).toBe(true);
 	expect(await fileExists('file-that-does-not-exist')).toBe(false);