mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* fix(ci): publish the pre-built tarball instead of re-packing
The release workflow built the tarball twice — once via pnpm pack in
artifacts:check (leaving it at dist/artifacts/npm/) and again inside
@semantic-release/npm's prepare step, which then tried to fs-extra
move npm pack's output into the same directory and crashed with
"dest already exists". On top of being a publish blocker, that meant
the published tarball was different from the one smoke-tested in
artifacts:check.
Drop @semantic-release/npm and publish the exact tarball that
artifacts:check verified via an exec publishCmd:
npm publish dist/artifacts/npm/kaelio-ktx-<v>.tgz \
--tag <next|latest> --access public --provenance
Auth uses OIDC trusted publishing — the workflow already grants
id-token: write and setup-node configures the registry, and
release-workflow.test.mjs asserts NODE_AUTH_TOKEN is not set.
* fix(ci): allow @kaelio/ktx tarball name in semantic-release config
The new publishCmd added in the previous commit hardcodes the
dist/artifacts/npm/kaelio-ktx-<v>.tgz path, which trips the boundary
check that forbids the literal product name outside release-machinery
files. The release config is exactly such a release-machinery file —
its job is to bridge the generic ktx project to the @kaelio/ktx npm
package — so add it to identifierAllowPatterns alongside the existing
build-public-npm-package and public-npm-release-metadata entries.
112 lines
5 KiB
JavaScript
112 lines
5 KiB
JavaScript
import assert from 'node:assert/strict';
|
|
import { createRequire } from 'node:module';
|
|
import { describe, it } from 'node:test';
|
|
|
|
const require = createRequire(import.meta.url);
|
|
const { createReleaseConfig, releaseBranches, releaseKind, releaseTag } = require('./semantic-release-config.cjs');
|
|
|
|
function releaseExecOptions(config) {
|
|
return config.plugins.find((plugin) => Array.isArray(plugin) && plugin[0] === '@semantic-release/exec' && plugin[1].prepareCmd)[1];
|
|
}
|
|
|
|
function releaseExecIndex(config) {
|
|
return config.plugins.findIndex((plugin) => Array.isArray(plugin) && plugin[0] === '@semantic-release/exec' && plugin[1].prepareCmd);
|
|
}
|
|
|
|
function pluginNames(config) {
|
|
return config.plugins.map((plugin) => (Array.isArray(plugin) ? plugin[0] : plugin));
|
|
}
|
|
|
|
describe('semantic-release config', () => {
|
|
it('configures rc releases on a dedicated next prerelease branch', () => {
|
|
assert.equal(releaseKind({ KTX_RELEASE_KIND: 'rc' }), 'rc');
|
|
assert.equal(releaseTag('rc'), 'next');
|
|
assert.deepEqual(releaseBranches({ KTX_RELEASE_KIND: 'rc', GITHUB_REF_NAME: 'main' }), [
|
|
'main',
|
|
{ name: 'next', prerelease: 'rc', channel: 'next' },
|
|
]);
|
|
|
|
const config = createReleaseConfig({ KTX_RELEASE_KIND: 'rc', GITHUB_REF_NAME: 'main' });
|
|
assert.equal(
|
|
config.plugins.find((plugin) => Array.isArray(plugin) && plugin[0] === '@semantic-release/npm'),
|
|
undefined,
|
|
'@semantic-release/npm must not run; the exec publishCmd publishes the pre-built tarball',
|
|
);
|
|
assert.match(
|
|
releaseExecOptions(config).prepareCmd,
|
|
/update-public-release-version\.mjs "\$\{nextRelease\.version\}" "next"/,
|
|
);
|
|
assert.match(
|
|
releaseExecOptions(config).publishCmd,
|
|
/^npm publish dist\/artifacts\/npm\/kaelio-ktx-\$\{nextRelease\.version\}\.tgz --tag next --access public --provenance/,
|
|
);
|
|
assert.match(releaseExecOptions(config).publishCmd, /pnpm run release:published-smoke/);
|
|
assert.doesNotMatch(JSON.stringify(config.plugins), /release:npm-publish/);
|
|
const releaseFilePluginNames = pluginNames(config).filter(
|
|
(plugin) => plugin === '@semantic-release/changelog' || plugin === '@semantic-release/git',
|
|
);
|
|
assert.deepEqual(releaseFilePluginNames, ['@semantic-release/changelog', '@semantic-release/git']);
|
|
|
|
const names = pluginNames(config);
|
|
assert.ok(names.indexOf('@semantic-release/changelog') < releaseExecIndex(config));
|
|
assert.ok(names.indexOf('@semantic-release/git') > releaseExecIndex(config));
|
|
});
|
|
|
|
it('configures stable releases only from main with latest tag', () => {
|
|
assert.equal(releaseKind({ KTX_RELEASE_KIND: 'stable' }), 'stable');
|
|
assert.equal(releaseTag('stable'), 'latest');
|
|
assert.deepEqual(releaseBranches({ KTX_RELEASE_KIND: 'stable', GITHUB_REF_NAME: 'main' }), ['main']);
|
|
|
|
const config = createReleaseConfig({ KTX_RELEASE_KIND: 'stable', GITHUB_REF_NAME: 'main' });
|
|
assert.match(
|
|
releaseExecOptions(config).prepareCmd,
|
|
/update-public-release-version\.mjs "\$\{nextRelease\.version\}" "latest"/,
|
|
);
|
|
assert.match(
|
|
releaseExecOptions(config).publishCmd,
|
|
/^npm publish dist\/artifacts\/npm\/kaelio-ktx-\$\{nextRelease\.version\}\.tgz --tag latest --access public --provenance/,
|
|
);
|
|
assert.equal(config.plugins.includes('./scripts/semantic-release-version-policy.cjs'), false);
|
|
});
|
|
|
|
it('does not commit release files back to protected main during stable releases', () => {
|
|
const config = createReleaseConfig({ KTX_RELEASE_KIND: 'stable', GITHUB_REF_NAME: 'main' });
|
|
|
|
assert.equal(pluginNames(config).includes('@semantic-release/git'), false);
|
|
assert.equal(pluginNames(config).includes('@semantic-release/changelog'), false);
|
|
});
|
|
|
|
it('rejects stable releases from non-main branches', () => {
|
|
assert.throws(
|
|
() => releaseBranches({ KTX_RELEASE_KIND: 'stable', GITHUB_REF_NAME: 'feature/release-test' }),
|
|
/Stable KTX releases must run from main, got feature\/release-test/,
|
|
);
|
|
});
|
|
|
|
it('keeps the force-release patch escape hatch', () => {
|
|
const config = createReleaseConfig({ KTX_RELEASE_KIND: 'rc', GITHUB_REF_NAME: 'main' });
|
|
const analyzeExec = config.plugins.find(
|
|
(plugin) => Array.isArray(plugin) && plugin[0] === '@semantic-release/exec' && plugin[1].analyzeCommitsCmd,
|
|
);
|
|
assert.match(analyzeExec[1].analyzeCommitsCmd, /FORCE_RELEASE === 'true' \? 'patch' : ''/);
|
|
});
|
|
|
|
it('does not configure any commit type to create an automatic major release', () => {
|
|
const config = createReleaseConfig({ KTX_RELEASE_KIND: 'stable', GITHUB_REF_NAME: 'main' });
|
|
const analyzer = config.plugins.find(
|
|
(plugin) => Array.isArray(plugin) && plugin[0] === '@semantic-release/commit-analyzer',
|
|
);
|
|
|
|
assert.equal(
|
|
analyzer[1].releaseRules.some((rule) => rule.release === 'major'),
|
|
false,
|
|
);
|
|
assert.deepEqual(
|
|
analyzer[1].releaseRules.filter((rule) => rule.breaking || rule.type === 'major'),
|
|
[
|
|
{ breaking: true, release: 'minor' },
|
|
{ type: 'major', release: 'minor' },
|
|
],
|
|
);
|
|
});
|
|
});
|