Skip to content

Commit

Permalink
docs(readme): Add usage explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
Tallyb committed Jun 10, 2018
1 parent 2b44751 commit 0b8f371
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

[![NPM][npm-nodei-image]][npm-nodei-url]


## Installation
```bash
npm i --save-dev mcfly-semantic-release
Expand All @@ -19,7 +20,13 @@ In your `package.json`
}
```

Optionnaly additional files or files patterns (globs) can be added to also have their version bumped
Running release will do the following:
- Bumps version. By default, this will publish a patch version, if you want to control the semver option you can pass an optional 'patch', 'minor' or 'major' to the `--type` argument.
- Updates version in files: by default it will only update the root level `package.json`. Optionnaly use `--file` to specify file paths or files patterns (globs) that can have their version updated as well. Files can be `package.json` files or `config.xml` files
- Commit the changed files with a standard commit message. Default message is `chore(app): Version <version number>`. Use `--production` to suffix the commit message with the work `production` (can be later used in CI)
- Generates changlog based on Angular standard commit messages.
- Generate a tag with the version number.
- Generates a github release with the version number.

```json
"scripts": {
Expand All @@ -36,8 +43,6 @@ Then, to publish a new version execute the following command:
npm run release
```

By default, this will publish a patch version, if you want to control the semver option you can pass an optional 'patch', 'minor' or 'major' type argument.

**Example :**

```bash
Expand Down

0 comments on commit 0b8f371

Please sign in to comment.