https://github.com/stormwarning/zazen-semantic-release
⛩️ Automate releases, free of weariness and confusion
https://github.com/stormwarning/zazen-semantic-release
semantic-release-config
Last synced: about 2 months ago
JSON representation
⛩️ Automate releases, free of weariness and confusion
- Host: GitHub
- URL: https://github.com/stormwarning/zazen-semantic-release
- Owner: stormwarning
- License: isc
- Created: 2018-11-08T18:03:53.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T12:16:33.000Z (almost 4 years ago)
- Last Synced: 2025-02-08T02:31:03.130Z (4 months ago)
- Topics: semantic-release-config
- Language: JavaScript
- Homepage:
- Size: 1.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# zazen-semantic-release
[![npm version][npm-img]][npm-url]
[![semantic-release][sr-img]][sr-url]
**[semantic-release][]** shareable config for [zazen][]-generated projects.
## Usage
### Local installation
```sh
npm i -D semantic-release @zazen/semantic-release
```
Add the following to your project’s `package.json`:
```json
{
"release": {
"extends": "@zazen/semantic-release"
}
}
```
### Global installation
```sh
npm install -g semantic-release @zazen/semantic-release
semantic-release -e @zazen/semantic-release
```
## Configuration
### Environment variables
| Variable | Description |
| ---------------------------- | ------------------------------------------ |
| `GH_TOKEN` or `GITHUB_TOKEN` | **Required.** To authenticate with GitHub. |
| `NPM_TOKEN` | **Required.** To authenticate with npm. |
### Additional options
This shareable config uses the [`@semantic-release/git`][],
[`@semantic-release/npm`][], [`@semantic-release/changelog`][], and
[`@semantic-release/github`][] plugins. See the documentation of each plugins
for additional options.
[npm-url]: https://www.npmjs.com/package/@zazen/semantic-release
[npm-img]: https://img.shields.io/npm/v/@zazen/semantic-release.svg?style=flat-square
[sr-url]: https://github.com/semantic-release/semantic-release
[sr-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square
[semantic-release]: https://github.com/semantic-release/semantic-release
[zazen]: https://github.com/stormwarning/zazen
[`@semantic-release/git`]: https://github.com/semantic-release/git
[`@semantic-release/npm`]: https://github.com/semantic-release/npm
[`@semantic-release/changelog`]: https://github.com/semantic-release/changelog
[`@semantic-release/github`]: https://github.com/semantic-release/github