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: docs/concepts/groups.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -28,12 +28,12 @@ For cases where it's necessary to bump packages together, `beachball` also provi
28
28
29
29
Groups can be added to the [configuration file](../overview/configuration). See the [`VersionGroupOptions` source](https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts) for full details.
|`include`|`string \| string[] \| true`| glob pattern(s) for package paths to include (see [notes on globs][1]). If `true`, include all packages except those matching `exclude`. |
35
-
|`exclude`|`string \| string[]`| glob pattern(s) for package paths to exclude (see [notes on globs][1]). |
36
-
|`disallowedChangeTypes`|`ChangeType[] \| null`| Disallow these change types for the group. |
|`include`|`string \| string[] \| true`| glob pattern(s) for package paths to include (see [notes on globs][1]). If `true`, include all packages except those matching `exclude`. |
35
+
|`exclude`|`string \| string[]`| glob pattern(s) for package paths to exclude (see [notes on globs][1]). This currently must use **negated patterns only** (will be fixed in version 3).|
36
+
|`disallowedChangeTypes`|`ChangeType[] \| null`| Disallow these change types for the group. |
37
37
38
38
Example:
39
39
@@ -58,12 +58,12 @@ If you only want to publish or record changes for certain packages, you should u
58
58
59
59
To show changes for multiple packages in one change file, use the `changelog.groups` option. See the [`ChangelogGroupOptions` source](https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts) for full details.
|`masterPackageName`|`string`| The main package which a group of changes bubbles up to. |
64
-
|`include`|`string \| string[] \| true`| glob pattern(s) for package paths to include (see [notes on globs][1]). If `true`, include all packages except those matching `exclude`. |
65
-
|`exclude`|`string \| string[]`| glob pattern(s) for package paths to exclude (see [notes on globs][1]). |
66
-
|`changelogPath`|`string`| Put the grouped changelog file under this directory. Can be relative to the root, or absolute. |
|`masterPackageName`|`string`| The main package which a group of changes bubbles up to. |
64
+
|`include`|`string \| string[] \| true`| glob pattern(s) for package paths to include (see [notes on globs][1]). If `true`, include all packages except those matching `exclude`. |
65
+
|`exclude`|`string \| string[]`| glob pattern(s) for package paths to exclude (see [notes on globs][1]). This currently must use **negated patterns only** (will be fixed in version 3).|
66
+
|`changelogPath`|`string`| Put the grouped changelog file under this directory. Can be relative to the root, or absolute. |
67
67
68
68
In this example, changelogs for all packages under `packages/*` (except `packages/baz`) are written to a `CHANGELOG.md` at the repo root (`.`), with `foo` as the master package. (To replace `foo`'s usual changelog with a grouped one, you'd specify `changelogPath` as the path to `foo` instead, e.g. `packages/foo`.)
0 commit comments