Skip to content

Commit ecf8ee2

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
feat: allow customizing release.yml build steps (#2053)
## PR Checklist - [x] Addresses an existing open issue: fixes #2052 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview 🎁
1 parent be66a23 commit ecf8ee2

File tree

4 files changed

+366
-4
lines changed

4 files changed

+366
-4
lines changed

‎src/blocks/blockReleaseIt.test.ts

+306
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
import { testBlock } from "bingo-stratum-testers";
2+
import { describe, expect, test } from "vitest";
3+
4+
import { blockReleaseIt } from "./blockReleaseIt.js";
5+
import { optionsBase } from "./options.fakes.js";
6+
7+
describe("blockReleaseIt", () => {
8+
test("without addons", () => {
9+
const creation = testBlock(blockReleaseIt, { options: optionsBase });
10+
11+
expect(creation).toMatchInlineSnapshot(`
12+
{
13+
"addons": [
14+
{
15+
"addons": {
16+
"words": [
17+
"apexskier",
18+
],
19+
},
20+
"block": [Function],
21+
},
22+
{
23+
"addons": {
24+
"properties": {
25+
"devDependencies": {
26+
"@release-it/conventional-changelog": "10.0.0",
27+
"release-it": "18.1.2",
28+
},
29+
"publishConfig": {
30+
"provenance": true,
31+
},
32+
"scripts": {
33+
"should-semantic-release": undefined,
34+
},
35+
},
36+
},
37+
"block": [Function],
38+
},
39+
{
40+
"addons": {
41+
"badges": [
42+
{
43+
"alt": "📦 npm version",
44+
"href": "http://npmjs.com/package/test-repository",
45+
"src": "https://img.shields.io/npm/v/test-repository?color=21bb42&label=%F0%9F%93%A6%20npm",
46+
},
47+
],
48+
},
49+
"block": [Function],
50+
},
51+
{
52+
"addons": {
53+
"dependencies": [
54+
"should-semantic-release",
55+
],
56+
},
57+
"block": [Function],
58+
},
59+
{
60+
"addons": {
61+
"secrets": [
62+
{
63+
"description": "a GitHub PAT with repo and workflow permissions",
64+
"name": "ACCESS_TOKEN",
65+
},
66+
{
67+
"description": "an npm access token with automation permissions",
68+
"name": "NPM_TOKEN",
69+
},
70+
],
71+
},
72+
"block": [Function],
73+
},
74+
],
75+
"files": {
76+
".github": {
77+
"workflows": {
78+
"post-release.yml": "jobs:
79+
post_release:
80+
runs-on: ubuntu-latest
81+
steps:
82+
- uses: actions/checkout@v4
83+
with:
84+
fetch-depth: 0
85+
- run: echo "npm_version=$(npm pkg get version | tr -d '"')" >> "$GITHUB_ENV"
86+
- uses: apexskier/github-release-commenter@v1
87+
with:
88+
GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
89+
comment-template: |
90+
:tada: This is included in version {release_link} :tada:
91+
92+
The release is available on:
93+
94+
* [GitHub releases](https://github.com/test-owner/test-repository/releases/tag/{release_tag})
95+
* [npm package (@latest dist-tag)](https://www.npmjs.com/package/test-repository/v/\${{ env.npm_version }})
96+
97+
Cheers! 📦🚀
98+
99+
name: Post Release
100+
101+
on:
102+
release:
103+
types:
104+
- published
105+
106+
permissions:
107+
issues: write
108+
pull-requests: write
109+
",
110+
"release.yml": "concurrency:
111+
group: \${{ github.workflow }}
112+
113+
jobs:
114+
release:
115+
runs-on: ubuntu-latest
116+
steps:
117+
- uses: actions/checkout@v4
118+
with:
119+
fetch-depth: 0
120+
ref: main
121+
token: \${{ secrets.ACCESS_TOKEN }}
122+
- uses: ./.github/actions/prepare
123+
- env:
124+
GITHUB_TOKEN: \${{ secrets.ACCESS_TOKEN }}
125+
NPM_TOKEN: \${{ secrets.NPM_TOKEN }}
126+
uses: JoshuaKGoldberg/[email protected]
127+
128+
name: Release
129+
130+
on:
131+
push:
132+
branches:
133+
- main
134+
135+
permissions:
136+
contents: write
137+
id-token: write
138+
",
139+
},
140+
},
141+
".release-it.json": "{"git":{"commitMessage":"chore: release v\${version}","requireCommits":true},"github":{"release":true,"releaseName":"v\${version}"},"npm":{"publishArgs":["--access public","--provenance"]},"plugins":{"@release-it/conventional-changelog":{"infile":"CHANGELOG.md","preset":"angular","types":[{"section":"Features","type":"feat"},{"section":"Bug Fixes","type":"fix"},{"section":"Performance Improvements","type":"perf"},{"hidden":true,"type":"build"},{"hidden":true,"type":"chore"},{"hidden":true,"type":"ci"},{"hidden":true,"type":"docs"},{"hidden":true,"type":"refactor"},{"hidden":true,"type":"style"},{"hidden":true,"type":"test"}]}}}",
142+
},
143+
}
144+
`);
145+
});
146+
147+
test("with addons", () => {
148+
const creation = testBlock(blockReleaseIt, {
149+
addons: {
150+
builders: [
151+
{
152+
order: 1,
153+
run: "one",
154+
},
155+
{
156+
order: 0,
157+
run: "zero",
158+
},
159+
{
160+
order: 2,
161+
run: "two",
162+
},
163+
],
164+
},
165+
options: optionsBase,
166+
});
167+
168+
expect(creation).toMatchInlineSnapshot(`
169+
{
170+
"addons": [
171+
{
172+
"addons": {
173+
"words": [
174+
"apexskier",
175+
],
176+
},
177+
"block": [Function],
178+
},
179+
{
180+
"addons": {
181+
"properties": {
182+
"devDependencies": {
183+
"@release-it/conventional-changelog": "10.0.0",
184+
"release-it": "18.1.2",
185+
},
186+
"publishConfig": {
187+
"provenance": true,
188+
},
189+
"scripts": {
190+
"should-semantic-release": undefined,
191+
},
192+
},
193+
},
194+
"block": [Function],
195+
},
196+
{
197+
"addons": {
198+
"badges": [
199+
{
200+
"alt": "📦 npm version",
201+
"href": "http://npmjs.com/package/test-repository",
202+
"src": "https://img.shields.io/npm/v/test-repository?color=21bb42&label=%F0%9F%93%A6%20npm",
203+
},
204+
],
205+
},
206+
"block": [Function],
207+
},
208+
{
209+
"addons": {
210+
"dependencies": [
211+
"should-semantic-release",
212+
],
213+
},
214+
"block": [Function],
215+
},
216+
{
217+
"addons": {
218+
"secrets": [
219+
{
220+
"description": "a GitHub PAT with repo and workflow permissions",
221+
"name": "ACCESS_TOKEN",
222+
},
223+
{
224+
"description": "an npm access token with automation permissions",
225+
"name": "NPM_TOKEN",
226+
},
227+
],
228+
},
229+
"block": [Function],
230+
},
231+
],
232+
"files": {
233+
".github": {
234+
"workflows": {
235+
"post-release.yml": "jobs:
236+
post_release:
237+
runs-on: ubuntu-latest
238+
steps:
239+
- uses: actions/checkout@v4
240+
with:
241+
fetch-depth: 0
242+
- run: echo "npm_version=$(npm pkg get version | tr -d '"')" >> "$GITHUB_ENV"
243+
- uses: apexskier/github-release-commenter@v1
244+
with:
245+
GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
246+
comment-template: |
247+
:tada: This is included in version {release_link} :tada:
248+
249+
The release is available on:
250+
251+
* [GitHub releases](https://github.com/test-owner/test-repository/releases/tag/{release_tag})
252+
* [npm package (@latest dist-tag)](https://www.npmjs.com/package/test-repository/v/\${{ env.npm_version }})
253+
254+
Cheers! 📦🚀
255+
256+
name: Post Release
257+
258+
on:
259+
release:
260+
types:
261+
- published
262+
263+
permissions:
264+
issues: write
265+
pull-requests: write
266+
",
267+
"release.yml": "concurrency:
268+
group: \${{ github.workflow }}
269+
270+
jobs:
271+
release:
272+
runs-on: ubuntu-latest
273+
steps:
274+
- uses: actions/checkout@v4
275+
with:
276+
fetch-depth: 0
277+
ref: main
278+
token: \${{ secrets.ACCESS_TOKEN }}
279+
- uses: ./.github/actions/prepare
280+
- run: zero
281+
- run: one
282+
- run: two
283+
- env:
284+
GITHUB_TOKEN: \${{ secrets.ACCESS_TOKEN }}
285+
NPM_TOKEN: \${{ secrets.NPM_TOKEN }}
286+
uses: JoshuaKGoldberg/[email protected]
287+
288+
name: Release
289+
290+
on:
291+
push:
292+
branches:
293+
- main
294+
295+
permissions:
296+
contents: write
297+
id-token: write
298+
",
299+
},
300+
},
301+
".release-it.json": "{"git":{"commitMessage":"chore: release v\${version}","requireCommits":true},"github":{"release":true,"releaseName":"v\${version}"},"npm":{"publishArgs":["--access public","--provenance"]},"plugins":{"@release-it/conventional-changelog":{"infile":"CHANGELOG.md","preset":"angular","types":[{"section":"Features","type":"feat"},{"section":"Bug Fixes","type":"fix"},{"section":"Performance Improvements","type":"perf"},{"hidden":true,"type":"build"},{"hidden":true,"type":"chore"},{"hidden":true,"type":"ci"},{"hidden":true,"type":"docs"},{"hidden":true,"type":"refactor"},{"hidden":true,"type":"style"},{"hidden":true,"type":"test"}]}}}",
302+
},
303+
}
304+
`);
305+
});
306+
});

‎src/blocks/blockReleaseIt.ts

+18-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { z } from "zod";
2+
13
import { base } from "../base.js";
24
import { getPackageDependencies } from "../data/packageData.js";
35
import { resolveUses } from "./actions/resolveUses.js";
@@ -12,7 +14,19 @@ export const blockReleaseIt = base.createBlock({
1214
about: {
1315
name: "release-it",
1416
},
15-
produce({ options }) {
17+
addons: {
18+
builders: z
19+
.array(
20+
z.object({
21+
order: z.number(),
22+
run: z.string(),
23+
}),
24+
)
25+
.default([]),
26+
},
27+
produce({ addons, options }) {
28+
const { builders } = addons;
29+
1630
return {
1731
addons: [
1832
blockCSpell({
@@ -135,9 +149,9 @@ export const blockReleaseIt = base.createBlock({
135149
{
136150
uses: "./.github/actions/prepare",
137151
},
138-
{
139-
run: "pnpm build",
140-
},
152+
...builders
153+
.sort((a, b) => a.order - b.order)
154+
.map(({ run }) => ({ run })),
141155
{
142156
env: {
143157
GITHUB_TOKEN: "${{ secrets.ACCESS_TOKEN }}",

0 commit comments

Comments
 (0)