semantic-release-npm-workspaces-monorepo/dist/settings.js

Help you use semantic-release with npm workspaces

import path from 'path';
import { cosmiconfig } from 'cosmiconfig';
import defaults from 'defaults';
const CONFIG_NAME = 'workspaceRelease';
export const SETTINGS = {
    preReleaseVersionTemplate: '${version}',
    registry: 'https://registry.npmjs.org',
    workspace: path.join(process.cwd(), 'packages'),
    tagFormat: '${name}@${version}',
    release: {
        extends: 'semantic-release-commit-filter',
        ci: true,
        branches: [
            'main',
            'master',
            {
                name: 'beta',
                prerelease: true,
            },
        ],
        plugins: [],
    },
    semanticReleaseBin: 'semantic-release',
    semanticReleaseBinArgs: [],
    changelogCommit: true,
    npmRelease: false,
    extendsReleaseRules: [],
    extendsNoteGeneratorTypes: [],
    extendsDefaultPlugins: [],
};
export async function importSettings() {
    const explorer = cosmiconfig(CONFIG_NAME);
    const result = await explorer.search();
    if (result) {
        Object.assign(SETTINGS, defaults(result.config, SETTINGS));
        SETTINGS.release.plugins = result.config?.release?.plugins;
    }
    SETTINGS.release.plugins ??= defaultPlugins();
}
function defaultPlugins() {
    return [
        [
            '@semantic-release/commit-analyzer',
            {
                preset: 'angular',
                releaseRules: [
                    ...SETTINGS.extendsReleaseRules,
                    {
                        breaking: true,
                        release: 'major',
                    },
                    {
                        revert: true,
                        release: 'patch',
                    },
                    {
                        type: '*!',
                        release: 'major',
                    },
                    {
                        type: 'breaking',
                        release: 'major',
                    },
                    ...(SETTINGS.npmRelease
                        ? [
                            {
                                type: 'docs',
                                scope: 'README',
                                release: 'patch',
                            },
                            {
                                type: 'refactor',
                                release: 'patch',
                            },
                            {
                                type: 'style',
                                release: 'patch',
                            },
                            {
                                type: 'types',
                                release: 'patch',
                            },
                        ]
                        : []),
                ],
                parserOpts: {
                    noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
                },
            },
        ],
        [
            '@semantic-release/release-notes-generator',
            {
                preset: 'angular',
                presetConfig: {
                    header: 'Release Notes',
                    types: [
                        ...SETTINGS.extendsNoteGeneratorTypes,
                        {
                            type: 'feat',
                            section: 'Features',
                        },
                        {
                            type: 'fix',
                            section: 'Bug Fixes',
                        },
                        {
                            type: 'chore',
                            hidden: true,
                        },
                        {
                            type: 'docs',
                            hidden: true,
                        },
                        {
                            type: 'style',
                            hidden: true,
                        },
                        {
                            type: 'refactor',
                            hidden: true,
                        },
                        {
                            type: 'perf',
                            hidden: true,
                        },
                        {
                            type: 'test',
                            hidden: true,
                        },
                    ],
                },
                parserOpts: {
                    noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
                },
                writerOpts: {
                    commitsSort: ['subject', 'scope'],
                },
            },
        ],
        ...(SETTINGS.changelogCommit ? ['@semantic-release/changelog'] : []),
        ...(SETTINGS.npmRelease ? ['@semantic-release/npm'] : []),
        ...(SETTINGS.changelogCommit
            ? [
                '@semantic-release/github',
                ['@semantic-release/git', { assets: ['CHANGELOG.md', 'LICENSE'] }],
            ]
            : []),
        ...SETTINGS.extendsDefaultPlugins,
        [
            '@semantic-release/exec',
            {
                publishCmd: 'npx -y semantic-release-npm-workspaces-monorepo cache ${nextRelease.version}',
            },
        ],
    ];
}