From 78360eb1a13ccc9ff27b2da86112cb4571f10714 Mon Sep 17 00:00:00 2001 From: yoavniran Date: Wed, 3 Dec 2025 11:53:28 +0200 Subject: [PATCH] fix: correct readme section on baseline updates --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 527e1b3..96529c4 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ jobs: ``` - `report-json`, `report-table`, and `report-file` outputs enable downstream workflows (PR comments, Slack alerts, artifact uploads, etc.). -- When `baseline-report-path` + `update-baseline` are set, the action refreshes the stored bundle size report on the branch that ran the workflow. If `baseline-report-path` is omitted and `report-file` is set, the baseline defaults to that path. The update runs on a dedicated branch + pull request using `update-pr-title`, `update-pr-body`, and `update-branch-prefix`. Use `baseline-protected-branches` (default `main,master`, supports glob patterns) to block updates on protected branches. +- When `baseline-report-path` + `update-baseline` are set, the action regenerates the stored bundle size report on a dedicated update branch (not the branch that triggered the workflow). If `baseline-report-path` is omitted and `report-file` is set, the baseline defaults to that path. The update runs on a dedicated branch + pull request using `update-pr-title`, `update-pr-body`, and `update-branch-prefix`. Use `baseline-protected-branches` (default `main,master`, supports glob patterns) to block updates on protected branches. - `comment-on-pr-always` (first run only) and `comment-on-pr-each-run` control when PR comments are posted even if checks pass. - Additional outputs (`report-file`, `baseline-updated`, `baseline-update-pr-url`, `baseline-update-pr-number`) make it easy to chain artifact uploads or follow-up workflows.