Techor's semantic release config for publishing workspace packages
## Getting Started
Skip if you have already run `npm install techor`:
```
npm install semantic-release-config-techor -D
```
### Configuration
Create a `release.config.js` file in your project root and extend `techor`:
```js
module.exports = {
extends: 'semantic-release-config-techor'
}
```
For full configuration, check out the [configure.js](https://github.com/1aron/techor/blob/beta/packages/semantic-release-config/configure.js) file and [Techor's conventional commits for the release rules](https://github.com/1aron/techor/tree/main/packages/conventional-commits)
Since `.plugins` use arrays for configuration, even `extends` will override all preset plugins.
I provide `configure(options)` API to allow you to set additional config friendly:
```js
const releaseRules = require('semantic-release-config-techor/rules')
const configure = require('semantic-release-config-techor/configure')
module.exports = configure({
branches: [
'+([0-9])?(.{+([0-9]),x}).x',
'main',
'next',
'next-major',
{
name: 'beta',
prerelease: true
},
{
name: 'alpha',
prerelease: true
}
],
plugins: {
'@semantic-release/commit-analyzer': { preset: 'techor', releaseRules },
'@semantic-release/release-notes-generator': { preset: 'techor' },
'@semantic-release/exec': {
prepareCmd: 'npm run check && npm run build',
publishCmd: 'techor version ${nextRelease.version}'
},
'@semantic-release/npm': true,
'@semantic-release/github': true
}
})
```
The above example is equivalent to the `extends: 'semantic-release-config-techor'` preset.
For example, to add assets for a GitHub Release and keep the default plugins:
```js
module.exports = configure({
plugins: {
'@semantic-release/github': {
assets: [
{
path: 'packages/css/dist/index.browser.js',
name: 'master-css.js',
label: 'master-css.js'
}
]
}
}
})
```
