Skip to content

docs: update README to include comment-body output #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rschristian merged 2 commits into from
Jun 19, 2026
Merged

docs: update README to include comment-body output #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a95c49f
docs: update README to include `comment-body` output
rzzf Jun 16, 2026
2d82566
Update README.md
rschristian Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ jobs:

> **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.

The markdown comment that `compressed-size-action` posts to pull requests is also exposed as the `comment-body` output. This can be used by later workflow steps to archive the report, pass it to another job, or post the comment from a separate workflow with the permissions you need:

```yaml
- id: compressed-size
uses: preactjs/compressed-size-action@v2

- name: Save compressed size comment
env:
COMMENT_BODY: ${{ steps.compressed-size.outputs.comment-body }}
run: printf '%s\n' "$COMMENT_BODY" > compressed-size-comment.md
```

### 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:
Expand Down