Skip to content

Commit ff767d2

Browse files
kaisermannbluwy
andauthored
Sync config-file-options documentation with schema.json and source code (#1683)
Co-authored-by: bluwy <bjornlu.dev@gmail.com>
1 parent 951094b commit ff767d2

1 file changed

Lines changed: 38 additions & 2 deletions

File tree

docs/config-file-options.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@ Changesets has a minimal amount of configuration options. Mostly these are for w
99
"fixed": [],
1010
"linked": [],
1111
"access": "restricted",
12-
"baseBranch": "main",
12+
"baseBranch": "master",
1313
"updateInternalDependencies": "patch",
14-
"ignore": []
14+
"ignore": [],
15+
"bumpVersionsWithWorkspaceProtocolOnly": false,
16+
"changedFilePatterns": ["**"],
17+
"prettier": true,
18+
"privatePackages": { "version": true, "tag": false }
1519
}
1620
```
1721

@@ -201,6 +205,18 @@ You can use the following placeholders for customizing the snapshot release vers
201205

202206
If you are not specifying `prereleaseTemplate`, the default behavior will fall back to using the following template: `{tag}-{datetime}`, and in cases where the tag is empty (`--snapshot` with no tag name), it will use `{datetime}` only.
203207

208+
## `prettier` (optional boolean)
209+
210+
This option configures whether Changesets will format its output using Prettier. When set to `false`, Changesets will skip formatting with Prettier.
211+
212+
Default value: `true`
213+
214+
```json
215+
{
216+
"prettier": false
217+
}
218+
```
219+
204220
## `privatePackages` (object or false)
205221

206222
This option is for setting how private packages should be handled. By default, Changesets will update the changelog for private packages and update their version, but will not create a tag. You can configure this option to change the default behavior.
@@ -227,3 +243,23 @@ When `tag` is set to `true`, Changesets will create a tag for private packages.
227243
}
228244
}
229245
```
246+
247+
## `changedFilePatterns` (array of strings)
248+
249+
Glob patterns for changed files that should mark a package as changed. Useful to fine-tune what counts as a change (e.g. only source files, ignoring test files, etc).
250+
251+
Default value:
252+
253+
```json
254+
{
255+
"changedFilePatterns": ["**"]
256+
}
257+
```
258+
259+
Example:
260+
261+
```json
262+
{
263+
"changedFilePatterns": ["src/**", "lib/**"]
264+
}
265+
```

0 commit comments

Comments
 (0)