Skip to content

Commit 1f46846

Browse files
authored
feat(security): offer Tuesday release date choices (#1110)
Signed-off-by: RafaelGSS <[email protected]>
1 parent ce38c70 commit 1f46846

4 files changed

Lines changed: 177 additions & 9 deletions

File tree

‎lib/cli.js‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,20 @@ export default class CLI {
102102
return inquirer.checkbox({ message, choices });
103103
}
104104

105+
async promptSelect(message, choices, opts = {}) {
106+
const defaultAnswer = opts.defaultAnswer ?? choices[0]?.value;
107+
108+
if (this.assumeYes) {
109+
return defaultAnswer;
110+
}
111+
112+
return inquirer.select({
113+
message,
114+
choices,
115+
default: defaultAnswer
116+
});
117+
}
118+
105119
setAssumeYes() {
106120
this.assumeYes = true;
107121
}

‎lib/prepare_security.js‎

Lines changed: 62 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,62 @@ function relativeDate(date) {
2525
return months === 1 ? '1 month ago' : `${months} months ago`;
2626
}
2727

28+
function formatDate(date) {
29+
const year = date.getFullYear();
30+
const month = String(date.getMonth() + 1).padStart(2, '0');
31+
const day = String(date.getDate()).padStart(2, '0');
32+
return `${year}/${month}/${day}`;
33+
}
34+
35+
function formatDaysFromNow(days) {
36+
return days === 1 ? 'in 1 day' : `in ${days} days`;
37+
}
38+
39+
function getNextTuesdayReleaseDateObjects(fromDate = new Date(), count = 4) {
40+
const TUESDAY = 2;
41+
const start = new Date(
42+
fromDate.getFullYear(),
43+
fromDate.getMonth(),
44+
fromDate.getDate()
45+
);
46+
const daysUntilTuesday = (TUESDAY - start.getDay() + 7) % 7 || 7;
47+
start.setDate(start.getDate() + daysUntilTuesday);
48+
49+
return Array.from({ length: count }, (_, index) => {
50+
const date = new Date(start);
51+
date.setDate(start.getDate() + (index * 7));
52+
return {
53+
date,
54+
daysFromNow: daysUntilTuesday + (index * 7)
55+
};
56+
});
57+
}
58+
59+
export function getNextTuesdayReleaseDates(fromDate = new Date(), count = 4) {
60+
return getNextTuesdayReleaseDateObjects(fromDate, count)
61+
.map(({ date }) => formatDate(date));
62+
}
63+
64+
export function getNextTuesdayReleaseDateChoices(fromDate = new Date(), count = 4) {
65+
const choices = getNextTuesdayReleaseDateObjects(fromDate, count)
66+
.map(({ date, daysFromNow }) => {
67+
const formattedDate = formatDate(date);
68+
return {
69+
name: formattedDate,
70+
value: formattedDate,
71+
description: `Tuesday, ${formatDaysFromNow(daysFromNow)}`
72+
};
73+
});
74+
75+
choices.push({
76+
name: 'TBD',
77+
value: 'TBD',
78+
description: 'Release date not defined yet'
79+
});
80+
81+
return choices;
82+
}
83+
2884
export default class PrepareSecurityRelease extends SecurityRelease {
2985
title = 'Next Security Release';
3086

@@ -182,15 +238,12 @@ export default class PrepareSecurityRelease extends SecurityRelease {
182238
}
183239

184240
async promptReleaseDate() {
185-
const nextWeekDate = new Date();
186-
nextWeekDate.setDate(nextWeekDate.getDate() + 7);
187-
// Format the date as YYYY/MM/DD
188-
const formattedDate = nextWeekDate.toISOString().slice(0, 10).replace(/-/g, '/');
189-
return this.cli.prompt(
190-
'Enter target release date in YYYY/MM/DD format (TBD if not defined yet):', {
191-
questionType: 'input',
192-
defaultAnswer: formattedDate
193-
});
241+
const choices = getNextTuesdayReleaseDateChoices();
242+
return this.cli.promptSelect(
243+
'Select target release date:',
244+
choices,
245+
{ defaultAnswer: choices[0].value }
246+
);
194247
}
195248

196249
async promptVulnerabilitiesJSON() {
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
import { describe, it } from 'node:test';
2+
import assert from 'node:assert';
3+
4+
import { confirmSecurityStep } from '../../lib/security-release/security-release.js';
5+
6+
describe('security release permissions', () => {
7+
it('asks permission for an individual step and defaults to no', async() => {
8+
const cli = {
9+
promptCalls: [],
10+
prompt(message, options) {
11+
this.promptCalls.push([message, options]);
12+
return true;
13+
}
14+
};
15+
16+
await confirmSecurityStep(
17+
cli,
18+
'run `git push -u origin next-security-release`',
19+
'This pushes the security release branch.'
20+
);
21+
22+
assert.deepStrictEqual(cli.promptCalls, [[
23+
'Allow action: run `git push -u origin next-security-release`?\n\n' +
24+
'This pushes the security release branch.',
25+
{ defaultAnswer: false }
26+
]]);
27+
});
28+
29+
it('aborts when an individual step is denied', async() => {
30+
const cli = {
31+
prompt() {
32+
return false;
33+
}
34+
};
35+
36+
await assert.rejects(() => confirmSecurityStep(
37+
cli,
38+
'write `security-release/next-security-release/vulnerabilities.json`',
39+
'This writes vulnerabilities.json.'
40+
), /Aborted: write `security-release\/next-security-release\/vulnerabilities\.json`\./);
41+
});
42+
});

‎test/unit/security_release.test.js‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ import { describe, it } from 'node:test';
22
import assert from 'node:assert';
33

44
import SecurityBlog from '../../lib/security_blog.js';
5+
import PrepareSecurityRelease, {
6+
getNextTuesdayReleaseDateChoices,
7+
getNextTuesdayReleaseDates
8+
} from '../../lib/prepare_security.js';
59
import {
610
getHighestSeverityAnnouncement
711
} from '../../lib/security-release/security-release.js';
@@ -91,6 +95,61 @@ describe('security_release: severity announcement', () => {
9195
});
9296
});
9397

98+
describe('security_release: release date choices', () => {
99+
it('starts with the next Tuesday when today is Tuesday', () => {
100+
assert.deepStrictEqual(
101+
getNextTuesdayReleaseDates(new Date(2026, 6, 7), 4),
102+
['2026/07/14', '2026/07/21', '2026/07/28', '2026/08/04']
103+
);
104+
});
105+
106+
it('uses the upcoming Tuesday when today is before Tuesday', () => {
107+
assert.deepStrictEqual(
108+
getNextTuesdayReleaseDates(new Date(2026, 6, 8), 3),
109+
['2026/07/14', '2026/07/21', '2026/07/28']
110+
);
111+
});
112+
113+
it('describes upcoming Tuesdays with relative timing', () => {
114+
assert.deepStrictEqual(
115+
getNextTuesdayReleaseDateChoices(new Date(2026, 6, 7), 2),
116+
[
117+
{
118+
name: '2026/07/14',
119+
value: '2026/07/14',
120+
description: 'Tuesday, in 7 days'
121+
},
122+
{
123+
name: '2026/07/21',
124+
value: '2026/07/21',
125+
description: 'Tuesday, in 14 days'
126+
},
127+
{
128+
name: 'TBD',
129+
value: 'TBD',
130+
description: 'Release date not defined yet'
131+
}
132+
]
133+
);
134+
});
135+
136+
it('prompts with upcoming Tuesdays and TBD', async() => {
137+
const release = new PrepareSecurityRelease({
138+
promptSelect(message, choices, options) {
139+
assert.strictEqual(message, 'Select target release date:');
140+
assert.deepStrictEqual(
141+
choices.map(({ value }) => value),
142+
[...getNextTuesdayReleaseDates(), 'TBD']
143+
);
144+
assert.strictEqual(options.defaultAnswer, choices[0].value);
145+
return choices[0].value;
146+
}
147+
});
148+
149+
assert.strictEqual(await release.promptReleaseDate(), getNextTuesdayReleaseDates()[0]);
150+
});
151+
});
152+
94153
describe('security_blog: pre-release severity wording', () => {
95154
it('does not include severity counts in the summary', () => {
96155
const blog = new SecurityBlog();

0 commit comments

Comments
 (0)