Merge branch 'master' into support-push

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: CI
 
-on: [pull_request_target, push]
+on: [pull_request, push]
 
 jobs:
   build_test:

README.md

@@ -29,8 +29,6 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - uses: preactjs/compressed-size-action@v2
-      with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
 ```
 
 ### Customizing the Build
@@ -66,10 +64,39 @@ jobs:
     - uses: actions/checkout@v2
     - uses: preactjs/compressed-size-action@v2
       with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
 +       build-script: "ci"
 ```
 
+#### Clean up state between builds
+
+For repositories or custom monorepo setups where files are modified in ways that are not reset by `npm ci && npm run build`, it may be necessary to define a custom "clean" script. This script resets any file modifications after the upstream (`target`) build ends and your PR code (`HEAD`) is checked out, but before installation of npm dependencies for `HEAD`:
+
+```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:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
++       clean-script: "clean"
+```
+
+```jsonc
+// package.json
+{
+  "scripts": {
+    // example - a simple nested node_modules setup:
+    "postinstall": "cd packages && npm i",
+    // between the two builds, we need to delete the inner node_modules:
+    "clean": "rm -rf packages/node_modules"
+  }
+}
+```
+
 ### Customizing the list of files
 
 `compressed-size-action` defaults to tracking the size of all JavaScript files within `dist/` directories - anywhere in your repository, not just at the root. You can change the list of files to be tracked and reported using the `pattern` and `exclude` options, both of which are [minimatch patterns](https://github.com/motemen/minimatch-cheat-sheet/blob/master/README.md):
@@ -84,7 +111,6 @@ jobs:
     - uses: actions/checkout@v2
     - uses: preactjs/compressed-size-action@v2
       with:
-        repo-token: "${{ secrets.GITHUB_TOKEN }}"
 +       pattern: "./build-output/**/*.{js,css,html,json}"
 +       exclude: "{./build-output/manifest.json,**/*.map,**/node_modules/**}"
 ```
@@ -127,3 +153,12 @@ By default, a file that's been changed by a single byte will be reported as chan
 ```
 
 In the above example, a file with a delta of less than 100 bytes will be reported as unchanged.
+
+### Compression
+
+By default, files are compared after gzip compression, but it's possible to use other compression algorithms (`gzip/brotli/none`) or disable the compression. 
+
+```yaml
+  compression: 'none'
+```
+

action.yml

@@ -7,7 +7,10 @@ branding:
 inputs:
   repo-token:
     description: 'The GITHUB_TOKEN secret'
-    required: true
+    required: false
+    default: ${{ github.token }}
+  clean-script:
+    description: 'An npm-script that cleans/resets state between branch builds'
   build-script:
     description: 'The npm-script to run that builds your project'
     default: 'build'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "compressed-size-action",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "index.js",
   "scripts": {
     "build": "microbundle -f cjs --define 'navigator={}' --compress --no-sourcemap --target node src/index.js",

src/index.js

@@ -50,8 +50,8 @@ async function run(octokit, context, token) {
 	const buildScript = getInput('build-script') || 'build';
 	const cwd = process.cwd();
 
-	const yarnLock = await fileExists(path.resolve(cwd, 'yarn.lock'));
-	const packageLock = await fileExists(path.resolve(cwd, 'package-lock.json'));
+	let yarnLock = await fileExists(path.resolve(cwd, 'yarn.lock'));
+	let packageLock = await fileExists(path.resolve(cwd, 'package-lock.json'));
 
 	let npm = `npm`;
 	let installScript = `npm install`;
@@ -107,7 +107,26 @@ async function run(octokit, context, token) {
 	}
 	endGroup();
 
+	const cleanScript = getInput('clean-script');
+	if (cleanScript) {
+		startGroup(`[base] Cleanup via ${npm} run ${cleanScript}`);
+		await exec(`${npm} run ${cleanScript}`);
+		endGroup();
+	}
+
 	startGroup(`[base] Install Dependencies`);
+
+	yarnLock = await fileExists(path.resolve(cwd, 'yarn.lock'));
+	packageLock = await fileExists(path.resolve(cwd, 'package-lock.json'));
+
+	if (yarnLock) {
+		installScript = npm = `yarn --frozen-lockfile`;
+	}
+	else if (packageLock) {
+		installScript = `npm ci`;
+	}
+
+	console.log(`Installing using ${installScript}`)
 	await exec(installScript);
 	endGroup();
 
@@ -261,7 +280,7 @@ async function createCheck(octokit, context) {
 
 (async () => {
 	try {
-		const token = getInput('repo-token', { required: true });
+		const token = getInput('repo-token');
 		const octokit = getOctokit(token);
 		await run(octokit, context, token);
 	} catch (e) {

src/utils.js

@@ -79,7 +79,7 @@ export function iconForDifference(delta, originalSize) {
 
 /**
  * Create a Markdown table from text rows
- * @param {string[]} rows
+ * @param {string[][]} rows
  */
 function markdownTable(rows) {
 	if (rows.length == 0) {
@@ -94,7 +94,16 @@ function markdownTable(rows) {
 	}
 
 	const [firstRow] = rows;
-	const columnLength = firstRow.length;
+	let columnLength = firstRow.length;
+
+	// Hide `Change` column if they are all `0 B`
+	if (columnLength === 3 && rows.every(columns => columns[2] === '0 B')) {
+		columnLength -= 1;
+		for (const columns of rows) {
+			columns.pop();
+		}
+	}
+
 	if (columnLength === 0) {
 		return '';
 	}

tests/__snapshots__/utils.spec.js.snap

@@ -13,9 +13,9 @@ exports[`diffTable 1`] = `
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
-| Filename | Size | Change |
-| :--- | :---: | :---: |
-| \`three.js\` | 300 B | 0 B |
+| Filename | Size |
+| :--- | :---: |
+| \`three.js\` | 300 B |
 
 </details>
 
@@ -31,9 +31,9 @@ exports[`diffTable 2`] = `
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
-| Filename | Size | Change |
-| :--- | :---: | :---: |
-| \`three.js\` | 300 B | 0 B |
+| Filename | Size |
+| :--- | :---: |
+| \`three.js\` | 300 B |
 
 </details>
 
@@ -96,12 +96,12 @@ exports[`diffTable 6`] = `
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
-| Filename | Size | Change |
-| :--- | :---: | :---: |
-| \`one.js\` | 5 kB | 0 B |
-| \`two.js\` | 5 kB | 0 B |
-| \`three.js\` | 300 B | 0 B |
-| \`four.js\` | 4.5 kB | 0 B |
+| Filename | Size |
+| :--- | :---: |
+| \`one.js\` | 5 kB |
+| \`two.js\` | 5 kB |
+| \`three.js\` | 300 B |
+| \`four.js\` | 4.5 kB |
 
 </details>
 
@@ -117,9 +117,9 @@ exports[`diffTable 7`] = `
 
 <details><summary>ℹ️ <strong>View Unchanged</strong></summary>
 
-| Filename | Size | Change |
-| :--- | :---: | :---: |
-| \`three.js\` | 300 B | 0 B |
+| Filename | Size |
+| :--- | :---: |
+| \`three.js\` | 300 B |
 
 </details>