@stencila/semantic-release-config/README.md

Shared semantic-release configuration for Stencila projects

# `@stencila/semantic-release-config`

> 💡 If your projects needs to publish to GitHub pages, you should use the related
> [`@stencila/semantic-release-config-gh-pages`](../semantic-release-config-gh-pages) package instead.

## Usage

From the project where you would like to use these settings, run

```bash
npm install @stencila/semantic-release-config --save-dev
```

Then modify your `package.json` to include the following code block. If you already
have a `release` configuration defined there, you’ll need to modify it.

```json5
  // …
  "release": {
    "extends": "@stencila/semantic-release-config"
  }
  // …
```

## References

- [Semantic Release Shared Configs](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/shareable-configurations.md)