Skip to content

Commit 6ce6acc

Browse files
committed
Update docs on groups
1 parent ad8c76d commit 6ce6acc

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/concepts/groups.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ For cases where it's necessary to bump packages together, `beachball` also provi
2828

2929
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.
3030

31-
| Name | Type | Description |
32-
| ----------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
33-
| `name` | `string` | Name of the version group |
34-
| `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. |
31+
| Name | Type | Description |
32+
| ----------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
33+
| `name` | `string` | Name of the version group |
34+
| `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. |
3737

3838
Example:
3939

@@ -58,12 +58,12 @@ If you only want to publish or record changes for certain packages, you should u
5858

5959
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.
6060

61-
| Name | Type | Description |
62-
| ------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
63-
| `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. |
61+
| Name | Type | Description |
62+
| ------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
63+
| `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. |
6767

6868
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`.)
6969

0 commit comments

Comments
 (0)