From 390407573281142b909e4d02306e11ed0704e6e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Sch=C3=A4fer?= Date: Mon, 20 Jan 2020 18:15:16 +0100 Subject: [PATCH] docs(Configuration): Fix typo, adds required version for custom version file management and references proper attribute name (`filename`) (#527) > I've spend at least an hour to figure out why my configuration files were always ignored. After debugging the source of my `node_modules/standard-version/*` it turns out I had `7.0.1` installed which apparently does not have the feature of `bumpFiles` or `packageFiles`. > I don't understand why `7.0.1` and not `7.1.0` got installed. I used `yarn add --dev standard-version`. @roschaefer Closes #504, #271 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6a0cb957c..33f014761 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ _How It Works:_ `standard-version` will then do the following: -1. Retreive the current version of your repository by looking at `bumpFiles`[[1]](#bumpfiles-packagefiles-and-updaters), falling back to the last `git tag`. +1. Retrieve the current version of your repository by looking at `bumpFiles`[[1]](#bumpfiles-packagefiles-and-updaters), falling back to the last `git tag`. 2. `bump` the version in `bumpFiles`[[1]](#bumpfiles-packagefiles-and-updaters) based on your commits. 4. Generates a `changelog` based on your commits (uses [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) under the hood). 5. Creates a new `commit` including your `bumpFiles`[[1]](#bumpfiles-packagefiles-and-updaters) and updated CHANGELOG. @@ -351,9 +351,9 @@ For this reason, we recommend keeping the scope of each PR to one general featur ### Can I use `standard-version` for additional metadata files, languages or version files? -YES! Using `bumpFiles` (and `packageFiles`) configurations you should be able to configure `standard-version` to work for you. +As of version `7.1.0` you can configure multiple `bumpFiles` and `packageFiles`. -1. Specify a custom `bumpFile` "`file`", this is the path to the file you want to "bump" +1. Specify a custom `bumpFile` "`filename`", this is the path to the file you want to "bump" 2. Specify the `bumpFile` "`updater`", this is _how_ the file will be bumped. a. If your using a common type, you can use one of `standard-version`'s built-in `updaters` by specifying a `type`.