Skip to content

docs: recommend job summary reports#17

Merged
jasonsaayman merged 1 commit into
mainfrom
docs/improve-readme
May 19, 2026
Merged

docs: recommend job summary reports#17
jasonsaayman merged 1 commit into
mainfrom
docs/improve-readme

Conversation

@jasonsaayman
Copy link
Copy Markdown
Member

@jasonsaayman jasonsaayman commented May 19, 2026

Summary

  • Removes README guidance for posting bundle-size reports as PR comments.
  • Documents appending bundle-size-comparison.md to $GITHUB_STEP_SUMMARY as the safe way to surface reports from pull-request-controlled code.

Testing

Docs-only change; tests and build were not run.

  • pnpm test
  • pnpm run build

Checklist

  • I updated tests or explained why no test changes are needed.
  • I updated documentation when behavior, inputs, outputs, or workflow usage changed.
  • I updated dist/index.js when runtime source, dependencies, or action metadata changed.
  • I kept JSON report behavior machine-readable and backward-compatible unless intentionally changed.

Summary by cubic

Recommend surfacing bundle-size reports via GitHub Actions job summaries instead of PR comments. This removes risky/complex comment workflows and shows the safe way to display reports from PR code.

  • Migration
    • In your pull_request workflow that runs axios/bundle-size@main, append bundle-size-comparison.md to $GITHUB_STEP_SUMMARY (e.g., cat bundle-size-comparison.md >> "$GITHUB_STEP_SUMMARY"). Remove any PR comment steps or workflow_run comment workflows.

Written for commit cdf2f0b. Summary will update on new commits. Review in cubic

@jasonsaayman jasonsaayman self-assigned this May 19, 2026
@jasonsaayman jasonsaayman added commit::docs The PR is related to docs priority::medium A medium priority labels May 19, 2026
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@jasonsaayman jasonsaayman merged commit 65ab57a into main May 19, 2026
7 checks passed
@jasonsaayman jasonsaayman deleted the docs/improve-readme branch May 19, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::docs The PR is related to docs priority::medium A medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant