mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-20 09:09:35 +02:00
Codeman maintainer
f2154a5d33
`changeset version` prefixes the first line of every committed changeset
with its commit ("- d18deed: **Lead.** text"), so a changeset that opens
with its bold lead-in, which is the shape the release notes ask for, was
never matched in a changesets-bot release. The pattern now allows that
prefix.
The release notes also put group labels in bold at the start of a line:
"**Fixes.**" and "**Fixes applied while landing.**" (1.41.1, 1.41.0,
1.35.0, 1.33.3). Those were taken as highlights, so a release with few
features announced "... · Fixes applied while landing". They are skipped
like the Thanks block. Tests cover both, and a release with no lead-ins.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
98 lines
3.9 KiB
TypeScript
98 lines
3.9 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { readFileSync } from 'node:fs';
|
|
import { resolve } from 'node:path';
|
|
// @ts-expect-error plain .mjs helper shared with scripts/generate-whats-new.mjs
|
|
import { extractHighlights, versionSection, buildWhatsNew } from '../scripts/lib/whats-new.mjs';
|
|
|
|
const root = resolve(import.meta.dirname, '..');
|
|
|
|
const CHANGELOG = `# aicodeman
|
|
|
|
## 1.2.0
|
|
|
|
### Minor Changes
|
|
|
|
- ### Thanks
|
|
- @someone for a fix
|
|
|
|
**The tile grid: six sessions side by side.** Body text with **inline bold** later.
|
|
|
|
- **Split view (#560).** More text.
|
|
- A bullet with no bold lead.
|
|
|
|
**Behaviour change: \`Ctrl+W\` no longer closes a session.** Details.
|
|
|
|
## 1.1.0
|
|
|
|
- **Old feature.** Not for 1.2.0.
|
|
`;
|
|
|
|
describe('whats-new extraction', () => {
|
|
it('limits itself to the requested version section', () => {
|
|
const section = versionSection(CHANGELOG, '1.2.0');
|
|
expect(section).toContain('tile grid');
|
|
expect(section).not.toContain('Old feature');
|
|
expect(versionSection(CHANGELOG, '9.9.9')).toBe('');
|
|
});
|
|
|
|
it('takes bold lead-ins only, cleaned, and skips the Thanks block', () => {
|
|
expect(extractHighlights(versionSection(CHANGELOG, '1.2.0'))).toEqual([
|
|
'The tile grid: six sessions side by side',
|
|
'Split view (#560)',
|
|
'Behaviour change: `Ctrl+W` no longer closes a session',
|
|
]);
|
|
});
|
|
|
|
it('reads a lead-in behind the commit prefix changesets writes for a committed changeset', () => {
|
|
const section = '- d18deed: **Each release announces itself (#618).** Text.\n- 13e652e: A fix with no lead-in.';
|
|
expect(extractHighlights(section)).toEqual(['Each release announces itself (#618)']);
|
|
});
|
|
|
|
it('skips group labels the release notes put in bold (Fixes, Fixes applied while landing)', () => {
|
|
const section = [
|
|
' **Tab layouts (#538).** Text.',
|
|
' **Fixes.**',
|
|
' - **Shells reload cleanly (#601).** Text.',
|
|
' **Fixes applied while landing.** Remote tabs keep their scrollback.',
|
|
].join('\n');
|
|
expect(extractHighlights(section)).toEqual(['Tab layouts (#538)', 'Shells reload cleanly (#601)']);
|
|
});
|
|
|
|
it('yields no highlights for a release written without bold lead-ins', () => {
|
|
const changelog =
|
|
'## 1.32.1\n\n### Patch Changes\n\n- 13e652e: Terminal copy: no gutter on the clipboard (#469).\n';
|
|
expect(buildWhatsNew(changelog, '1.32.1')).toEqual({ version: '1.32.1', highlights: [] });
|
|
});
|
|
|
|
it('caps the list', () => {
|
|
const many = Array.from({ length: 20 }, (_, i) => `**Feature number ${i}.** text`).join('\n\n');
|
|
expect(extractHighlights(many)).toHaveLength(8);
|
|
});
|
|
|
|
it('builds the payload the client reads', () => {
|
|
expect(buildWhatsNew(CHANGELOG, '1.2.0').version).toBe('1.2.0');
|
|
});
|
|
});
|
|
|
|
describe('shipped whats-new.json', () => {
|
|
it("matches the package version, so a release cannot ship the previous release's notes", () => {
|
|
const pkg = JSON.parse(readFileSync(resolve(root, 'package.json'), 'utf8'));
|
|
const notes = JSON.parse(readFileSync(resolve(root, 'src/web/public/whats-new.json'), 'utf8'));
|
|
expect(notes.version).toBe(pkg.version);
|
|
// A release written without bold lead-ins legitimately has none (the client then stays
|
|
// quiet), so an empty list must not turn the release commit's CI red.
|
|
expect(Array.isArray(notes.highlights)).toBe(true);
|
|
});
|
|
|
|
it('is regenerated by the release script and consumed once per version by the client', () => {
|
|
const pkg = readFileSync(resolve(root, 'package.json'), 'utf8');
|
|
expect(pkg).toMatch(/"version-packages": "changeset version && node scripts\/generate-whats-new\.mjs/);
|
|
const ui = readFileSync(resolve(root, 'src/web/public/settings-ui.js'), 'utf8');
|
|
expect(ui).toContain("'codeman-whats-new-seen'");
|
|
expect(ui).toContain("fetch('/whats-new.json'");
|
|
expect(readFileSync(resolve(root, 'src/web/public/app.js'), 'utf8')).toContain(
|
|
'this.checkWhatsNew?.(data.version)'
|
|
);
|
|
});
|
|
});
|