golem15/msd-core
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix(#2716): route non-user-facing conventional types to an Internal bucket, omit from release notes (#2838)

Browse Source 
* test(#2716): failing-first regression for non-user-facing types → Internal bucket

* fix(#2716): route non-user-facing conventional types to an Internal bucket, omit from release notes

* fix(#2716): update SAMPLE_BODY/Discord/property tests for Internal bucket; fix stale CONTRIBUTING sentence (review)

* test(#2716): relax Discord Enhancement assertion (enhance: prefix not stripped by cleanBullet)

* docs(changeset): #2716 non-user-facing types omitted from release notes

* docs(changeset): backfill #2716 PR number to 2838
This commit is contained in:
Tom Boucher
2026-07-29 17:06:04 -04:00
committed by GitHub
parent 6a9babda69
commit 1fc21cdee0
8 changed files with 104 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
tests/format-github-release-notes.test.cjs
View File

@@ -48,17 +48,17 @@ describe('classifyTitle', () => {
);
});
test('returns Enhancement for chore(#2): title', () => {
test('returns Internal for chore(#2): title (#2716)', () => {
assert.equal(
classifyTitle('* chore(#2): some chore by @trek-e in https://github.com/open-gsd/gsd-core/pull/5'),
'Enhancement'
'Internal'
);
});
test('returns Enhancement for docs: title', () => {
test('returns Internal for docs: title (#2716)', () => {
assert.equal(
classifyTitle('* docs: documentation update by @trek-e in https://github.com/open-gsd/gsd-core/pull/6'),
'Enhancement'
'Internal'
);
});
@@ -84,7 +84,7 @@ describe('classifyTitle', () => {
const SAMPLE_BODY = `## What's Changed
* feat(#39): milestone-prefixed phase IDs by @trek-e in https://github.com/open-gsd/gsd-core/pull/565
* fix(#557): milestone erased on update by @trek-e in https://github.com/open-gsd/gsd-core/pull/563
* chore(#2): update dependencies by @trek-e in https://github.com/open-gsd/gsd-core/pull/560
* enhance(#2): smoother phase transitions by @trek-e in https://github.com/open-gsd/gsd-core/pull/560
## New Contributors
* @someone made their first contribution in https://github.com/open-gsd/gsd-core/pull/123
@@ -217,4 +217,31 @@ describe('formatReleaseNotes', () => {
assert.ok(secondIdx !== -1, 'second feature bullet should be present');
assert.ok(firstIdx < secondIdx, 'first feature should appear before second feature');
});
test('#2716: a test:-titled PR is omitted from the rendered release notes entirely', () => {
const body = `## What's Changed
* feat(#39): real feature by @trek-e in https://github.com/open-gsd/gsd-core/pull/565
* test(#99): add regression coverage by @trek-e in https://github.com/open-gsd/gsd-core/pull/900
## New Contributors
**Full Changelog**: https://github.com/open-gsd/gsd-core/compare/v1.2.0...v1.3.0-rc.1
`;
const out = formatReleaseNotes({
generatedBody: body,
version: '1.3.0-rc.1',
prerelease: true,
packageName: '@opengsd/gsd-core',
});
// The feature bullet must appear under ### Feature.
assert.ok(out.includes('feat(#39): real feature'), 'feature bullet must be present');
assert.ok(out.includes('### Feature'), 'Feature section must render');
// The test:-titled PR must NOT appear anywhere in the user-facing output.
assert.ok(
!out.includes('test(#99): add regression coverage'),
'a test:-titled PR must be omitted from the rendered release notes (#2716)',
);
// And there must be no user-facing "Enhancement" section here (only the feature).
assert.ok(!out.includes('### Enhancement'), 'no Enhancement section expected when the only non-feature is Internal');
});
});