You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ The action automatically detects the build flow based on GitHub context:
71
71
72
72
When `commit-convention-enabled: 'true'` blocks a build, the `build-flow-type` output is set to `skip` and `build-skipped` becomes `true`.
73
73
74
-
For a planned main-branch release candidate, set both `planned-version` and `planned-npm-tag`. The action publishes those values on the main push; a planned publish fails only when every selected registry fails.
74
+
For a planned main-branch release candidate, set both `planned-version` and `planned-npm-tag`. The action publishes those values on the main push; a planned publish fails only when every selected registry fails. In monorepo mode, pass the release action's `packages-updated` output as `planned-package-versions` with `planned-npm-tag`; its `{path, version}` entries select and version the planned packages.
75
75
76
76
### Flow Examples
77
77
@@ -182,6 +182,7 @@ Tag: patch
182
182
|`version-prefix`| Accepted for backward compatibility but ignored at runtime because npm package versions must remain valid SemVer | - | No |
183
183
|`planned-version`| SemVer version to publish for a push to `main`; must be paired with `planned-npm-tag`| - | No |
184
184
|`planned-npm-tag`| npm dist-tag to use with `planned-version`; must be paired with `planned-version`| - | No |
185
+
|`planned-package-versions`|`packages-updated` JSON from `release-build-flow-action`; in monorepo mode on a push to `main`, each unique `{path, version}` entry is published with `planned-npm-tag` (directory paths and `package.json` paths are accepted; extra release-plan fields are ignored) | - | No |
185
186
186
187
### Commit Convention Gate Configuration
187
188
@@ -243,7 +244,7 @@ Tag: patch
243
244
|`short-sha`| Short commit SHA (single-package mode) |
244
245
|`npm-published`| Whether published to NPM (true/false) (single-package mode) |
245
246
|`github-published`| Whether published to GitHub Packages (true/false) (single-package mode) |
246
-
|`artifact-published`| Whether publishing succeeded in at least one registry (true/false) (single-package mode) |
247
+
|`artifact-published`| Whether publishing succeeded in at least one configured registry (singlepackage or any monorepo package) |
if!echo"$PLANNED_PACKAGE_VERSIONS"| jq -e 'type == "array" and length > 0 and all(.[]; type == "object" and (.path | type == "string" and length > 0) and (.version | type == "string" and length > 0)) and (map(.path) as $paths | ($paths | length) == ($paths | unique | length))'>/dev/null 2>&1;then
122
+
echo"❌ Error: planned-package-versions must be a JSON array of unique {path, version} objects"
0 commit comments