preactjs/compressed-size-action

Get compressed size differences for every PR

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
repo-token	The GITHUB_TOKEN secret	no	${{ github.token }}
base-ref	A specific git ref (branch, tag, or SHA) to compare against instead of the PR base branch	no	—
clean-script	An npm-script that cleans/resets state between branch builds	—	—
install-script	Custom installation script to run to set up the dependencies in your project	no	—
build-script	The npm-script to run that builds your project	—	build
compression	The compression algorithm to use: "gzip" or "brotli"	—	gzip
show-total	Show total size and difference.	—	true
collapse-unchanged	Move unchanged files into a separate collapsed table	—	true
omit-unchanged	Exclude unchanged files from the sizes table entirely	—	—
strip-hash	A regular expression to remove hashes from filenames. Submatches are turned into asterisks if present, otherwise the whole match is removed.	—	—
use-check	Report status as a CI Check instead of using a comment [experimental]	—	—
minimum-change-threshold	Consider files with changes below this threshold as unchanged. Specified in bytes.	—	1
pattern	minimatch pattern of files to track	—	—
exclude	minimatch pattern of files NOT to track	—	—
cwd	A custom working directory to execute the action in relative to repo root (defaults to .)	—	—
comment-key	Optional key to include in the bot comment to allow for multiple bundle calculations to be posted in separate comments.	—	—
sort-by	The column and direction to sort the results by. The format is "column:direction", where column is one of "Filename", "Size", or "Change" and direction is "asc" or "desc". For example, "Size:desc" sorts the table by file size in descending order.	—	Filename:asc

Outputs

name	description
comment-body	The full Markdown body the action posts to the PR, including the size report and footer.