Skip to content

Commit

Permalink
Fix publishing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris ter Beke authored and Dimitriovski committed Apr 24, 2020
1 parent 6f991ba commit cb1b9f1
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,37 +27,6 @@ module.exports = {
};
```

## Publishing

To publish a new version run `npm version` with the appropriate parameters (see
[npm-version](https://docs.npmjs.com/cli/version)). This will update
`package.json` for you, commit it and create an annotated tag. After pushing, CI
will pick this up and automatically publish to the npm registry. Next go to
[releases](https://github.com/Ultimaker/stylelint-config/releases) on GitHub and
document the changes.

### Example

The following example will bump the minor version number.

```shell
$ npm version minor
$ git push --follow-tags
```

> **Note:** This version will be published as soon as your changes are merged to
> `master`.

### Example: _alpha_ version

The following example will explicitly set the version to `1.0.0-alpha.4`.

```shell
$ npm version 1.0.0-alpha.4
$ git push --follow-tags
```

> **Note:** This version will be published to the npm registry while you are
> still working on your branch.
> **Note:** Alpha versions cannot be bumped automatically using `npm version`.
## Publishing
Publishing works the same way as we have implemented in [stardust-web](https://github.com/Ultimaker/stardust-web/blob/master/docs/publishing.md).

0 comments on commit cb1b9f1

Please sign in to comment.