release.config.cjs

/**
 * @type {import('semantic-release').GlobalConfig}
 */
module.exports = {
	branches: ['main', { name: 'beta', channel: 'beta', prerelease: true }],
	plugins: [
		// Run in order:
		// 1. Analyze commits to determine release type
		[
			'@semantic-release/commit-analyzer',
			{
				preset: 'angular',
				releaseRules: [
					{ type: 'feature', release: 'minor'},
					{ type: 'docs', message: '*README*', release: 'patch' },
					{ type: 'refactor', release: 'patch' },
					{ type: 'style', release: 'patch' },
					{ type: 'chore', release: 'patch' },
				],
				parserOpts: {
					noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
				},
			},
		],

		// 2. Generate release notes
		[
			'@semantic-release/release-notes-generator',
			{
				preset: 'angular',
				parserOpts: {
					noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING'],
				},
				writerOpts: {
					commitsSort: ['subject', 'scope'],
				},
				presetConfig: {
					types: [
						{ type: 'feat', section: 'Features' },
						{ type: 'feature', section: 'Features' },
						{ type: 'fix', section: 'Bug Fixes' },
						{ type: 'hotfix', section: 'Bug Fixes' },
						{ type: 'docs', section: 'Docs' },
						{ type: 'refactor', section: 'Refactoring' },
						{ type: 'perf', section: 'Performance Improvements' },
						{ type: 'ci', section: 'CI/CD Changes' },
						{ type: 'test', section: 'Tests' },
					],
				},
			},
		],

		// 3. Update CHANGELOG (must be called before /npm)
		[
			'@semantic-release/changelog',
			{
				changelogFile: 'CHANGELOG.md',
			},
		],

		// 4. Publish to npm (must be called after /changelog and before /git)
		'@semantic-release/npm',

		// 5. Publish to GH
		'@semantic-release/github',


		/* TODO: Use either of the below strategies to raise PR against `main` or commit directly to `main`
		*** */
		// 6. Update version with new release PR raised against main (in lieu of direct commit for now)
		// If we're going to use this, it will require a shim. See errors in console.
		// [
    //   "semantic-release-github-pullrequest", {
    //     "assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
    //     "baseRef": "main",
		// 		"branch": 'semantic-release-pr<%= nextRelease.version %>',
		// 		"pullRequestTitle": "chore(release) <%= nextRelease.version %>",

    //   }
    // ]


		// TODO: Fix token
		// // 6. Update version with new release commit (must be called after /changelog and /npm)
		// [
		// 	'@semantic-release/git',
		// 	{
		// 		assets: ['docs', 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'],
		// 		message:
					// "chore(release) <%= nextRelease.version %> - <%= new Date().toLocaleDateString('en-US', {year: 'numeric', month: 'short', day: 'numeric', hour: 'numeric', minute: 'numeric' }) %> [skip ci]\n\n<%= nextRelease.notes %> ",
		// 	},
		// ],
	],
};