semantic-release-config-aron v1.6.0

Getting Started

Skip if you have already run npm install aronrepo:

npm install semantic-release-config-aron -D

Configuration

Create a release.config.js file in your project root and extend aron:

module.exports = {
    extends: 'semantic-release-config-aron'
}

For full configuration, check out the configure.js file and Aron's conventional commits for the release rules

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:

const releaseRules = require('semantic-release-config-aron/rules')
const configure = require('semantic-release-config-aron/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: 'aron', releaseRules },
        '@semantic-release/release-notes-generator': { preset: 'aron' },
        '@semantic-release/exec': {
            prepareCmd: 'npm run check && npm run build',
            publishCmd: 'aron version ${nextRelease.version}'
        },
        '@semantic-release/npm': true,
        '@semantic-release/github': true
    }
})

The above example is equivalent to the extends: 'semantic-release-config-aron' preset.

For example, to add assets for a GitHub Release and keep the default plugins:

module.exports = configure({
    plugins: {
        '@semantic-release/github': {
            assets: [
                 {
                    path: 'packages/css/dist/index.browser.js',
                    name: 'master-css.js',
                    label: 'master-css.js'
                }
            ]
        }
    }
})