Skip to content

Commit dcfa47b

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
feat: standalone CTA Transitions workflow (#2012)
<!-- 👋 Hi, thanks for sending a PR to create-typescript-app! 🎁. Please fill out all fields below and make sure each item is true and [x] checked. Otherwise we may not be able to review your PR. --> ## PR Checklist - [x] Addresses an existing open issue: fixes #2009 - [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 Moves the transition mode logic into two files: 1. `.github/actions/transition/action.yml`: A dedicated composite action for running in transition mode and checking in & commenting any changes 2. `.github/workflows/cta.yml`: Checks if the action should be run, and runs it if so This means the job won't be marked as _Skipped_ if the logic is skipped. It'll still be _Success_ and thus not block PRs. 🎁
1 parent 5ae2bf5 commit dcfa47b

5 files changed

+216
-143
lines changed

‎src/blocks/blockCTATransitions.test.ts

+87-61
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import { describe, expect, test } from "vitest";
33

44
import { packageData } from "../data/packageData.js";
55
import { blockCTATransitions } from "./blockCTATransitions.js";
6-
import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
76
import { blockPackageJson } from "./blockPackageJson.js";
7+
import { blockRepositoryBranchRuleset } from "./blockRepositoryBranchRuleset.js";
88
import { optionsBase } from "./options.fakes.js";
99

1010
describe("blockCTATransitions", () => {
@@ -13,67 +13,93 @@ describe("blockCTATransitions", () => {
1313
options: optionsBase,
1414
});
1515

16-
expect(creation).toEqual({
17-
addons: [
18-
{
19-
addons: {
20-
jobs: [
21-
{
22-
checkoutWith: {
23-
"fetch-depth": "0",
24-
ref: "${{github.event.pull_request.head.ref}}",
25-
repository:
26-
"${{github.event.pull_request.head.repo.full_name}}",
27-
token: '"${{ secrets.ACCESS_TOKEN }}"',
28-
},
29-
if: "${{ startsWith(github.head_ref, 'renovate/') && contains(github.event.pull_request.title, 'create-typescript-app') }}",
30-
name: "CTA Transitions",
31-
steps: [
32-
{
33-
run: "pnpx create-typescript-app",
34-
},
35-
{
36-
uses: "stefanzweifel/git-auto-commit-action@v5",
37-
with: {
38-
commit_author:
39-
"The Friendly Bingo Bot <[email protected]>",
40-
commit_message:
41-
"Check in changes from re-running npx create-typescript-app",
42-
commit_user_email: "[email protected]",
43-
commit_user_name: "The Friendly Bingo Bot",
44-
},
45-
},
46-
{
47-
uses: "mshick/add-pr-comment@v2",
48-
with: {
49-
issue: "${{ github.event.pull_request.number }}",
50-
message: `|
51-
🤖 Beep boop! I ran \`npx create-typescript-app\` and found same changes.
52-
Please review the latest commit to see if you want to merge it.
53-
Cheers! 💝
54-
55-
> This change was automatically made in CI to keep your repository up-to-date with the templating in [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).
56-
> If you want to opt out of these automatic updates, delete the \`.github/workflows/cta-transitions.yml\` file on your \`main\` branch.`,
57-
"repo-token": "${{ secrets.ACCESS_TOKEN }}",
58-
},
59-
},
60-
],
61-
},
62-
],
63-
},
64-
block: blockGitHubActionsCI,
65-
},
66-
{
67-
addons: {
68-
properties: {
69-
devDependencies: {
70-
"create-typescript-app": packageData.version,
71-
},
72-
},
16+
expect(creation.addons).toEqual([
17+
blockPackageJson({
18+
properties: {
19+
devDependencies: {
20+
"create-typescript-app": packageData.version,
7321
},
74-
block: blockPackageJson,
7522
},
76-
],
77-
});
23+
}),
24+
blockRepositoryBranchRuleset({
25+
requiredStatusChecks: ["Transition"],
26+
}),
27+
]);
28+
expect(creation.files).toMatchInlineSnapshot(`
29+
{
30+
".github": {
31+
"actions": {
32+
"transition": {
33+
"action.yml": "description: Runs create-typescript-app in transition mode
34+
35+
name: Transition
36+
37+
runs:
38+
steps:
39+
- uses: ./.github/actions/prepare
40+
- run: pnpx create-typescript-app
41+
shell: bash
42+
- id: auto-commit-action
43+
uses: stefanzweifel/git-auto-commit-action@v5
44+
with:
45+
commit_author: The Friendly Bingo Bot <[email protected]>
46+
commit_message: Check in changes from re-running npx create-typescript-app
47+
commit_user_email: [email protected]
48+
commit_user_name: The Friendly Bingo Bot
49+
- if: steps.auto-commit-action.outputs.changes_detected == 'true'
50+
uses: mshick/add-pr-comment@v2
51+
with:
52+
issue: \${{ github.event.pull_request.number }}
53+
message: >-
54+
🤖 Beep boop! I ran \`pnpx create-typescript-app\` and it updated some
55+
files.
56+
57+
I went ahead and checked those changes into this PR for you. Please
58+
review the latest commit to see if you want to merge it.
59+
60+
Cheers!
61+
— _The Friendly Bingo Bot_ 💝
62+
63+
> ℹ️ These automatic commits keep your repository up-to-date with new
64+
versions of
65+
[create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).
66+
If you want to opt out, delete your
67+
\`.github/workflows/cta-transitions.yml\` file.
68+
using: composite
69+
",
70+
},
71+
},
72+
"workflows": {
73+
"cta.yml": "jobs:
74+
transition:
75+
name: Transition
76+
runs-on: ubuntu-latest
77+
steps:
78+
- uses: actions/checkout@v4
79+
with:
80+
fetch-depth: 0
81+
ref: \${{github.event.pull_request.head.ref}}
82+
repository: \${{github.event.pull_request.head.repo.full_name}}
83+
token: \${{ secrets.ACCESS_TOKEN }}
84+
- id: check
85+
if: (github.actor == 'test-owner' || github.actor == 'renovate[bot]') && startsWith(github.head_ref, 'renovate/') && contains(github.event.pull_request.title, 'create-typescript-app')
86+
uses: ./.github/actions/transition
87+
- if: steps.check.outcome == 'skipped'
88+
run: echo 'Skipping transition mode because the PR does not appear to be an automated or owner-created update to create-typescript-app.'
89+
90+
name: CTA
91+
92+
on:
93+
pull_request:
94+
branches:
95+
- main
96+
97+
permissions:
98+
pull-requests: write
99+
",
100+
},
101+
},
102+
}
103+
`);
78104
});
79105
});

‎src/blocks/blockCTATransitions.ts

+89-48
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
import { base } from "../base.js";
22
import { packageData } from "../data/packageData.js";
33
import { resolveUses } from "./actions/resolveUses.js";
4-
import { blockGitHubActionsCI } from "./blockGitHubActionsCI.js";
54
import { blockPackageJson } from "./blockPackageJson.js";
5+
import { blockRepositoryBranchRuleset } from "./blockRepositoryBranchRuleset.js";
6+
import { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.js";
7+
import { formatYamlAction } from "./files/formatYamlAction.js";
68

79
export const blockCTATransitions = base.createBlock({
810
about: {
@@ -11,66 +13,105 @@ export const blockCTATransitions = base.createBlock({
1113
produce({ options }) {
1214
return {
1315
addons: [
14-
blockGitHubActionsCI({
15-
jobs: [
16-
{
17-
checkoutWith: {
18-
"fetch-depth": "0",
19-
ref: "${{github.event.pull_request.head.ref}}",
20-
repository:
21-
"${{github.event.pull_request.head.repo.full_name}}",
22-
token: '"${{ secrets.ACCESS_TOKEN }}"',
16+
blockPackageJson({
17+
properties: {
18+
devDependencies: {
19+
"create-typescript-app": packageData.version,
20+
},
21+
},
22+
}),
23+
blockRepositoryBranchRuleset({
24+
requiredStatusChecks: ["Transition"],
25+
}),
26+
],
27+
files: {
28+
".github": {
29+
actions: {
30+
transition: {
31+
"action.yml": formatYamlAction({
32+
description: "Runs create-typescript-app in transition mode",
33+
name: "Transition",
34+
runs: {
35+
steps: [
36+
{ uses: "./.github/actions/prepare" },
37+
{
38+
run: "pnpx create-typescript-app",
39+
shell: "bash",
40+
},
41+
{
42+
id: "auto-commit-action",
43+
uses: "stefanzweifel/git-auto-commit-action@v5",
44+
with: {
45+
commit_author:
46+
"The Friendly Bingo Bot <[email protected]>",
47+
commit_message:
48+
"Check in changes from re-running npx create-typescript-app",
49+
commit_user_email: "[email protected]",
50+
commit_user_name: "The Friendly Bingo Bot",
51+
},
52+
},
53+
{
54+
if: "steps.auto-commit-action.outputs.changes_detected == 'true'",
55+
uses: "mshick/add-pr-comment@v2",
56+
with: {
57+
issue: "${{ github.event.pull_request.number }}",
58+
message: [
59+
"🤖 Beep boop! I ran `pnpx create-typescript-app` and it updated some files.",
60+
"I went ahead and checked those changes into this PR for you. Please review the latest commit to see if you want to merge it.",
61+
"Cheers!",
62+
" — _The Friendly Bingo Bot_ 💝",
63+
"",
64+
"> ℹ️ These automatic commits keep your repository up-to-date with new versions of [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app). If you want to opt out, delete your `.github/workflows/cta-transitions.yml` file.",
65+
].join("\n"),
66+
},
67+
},
68+
],
69+
using: "composite",
70+
},
71+
}),
72+
},
73+
},
74+
workflows: {
75+
"cta.yml": createSoloWorkflowFile({
76+
jobName: "Transition",
77+
name: "CTA",
78+
on: {
79+
pull_request: {
80+
branches: ["main"],
81+
},
82+
},
83+
permissions: {
84+
"pull-requests": "write",
2385
},
24-
if: "${{ startsWith(github.head_ref, 'renovate/') && contains(github.event.pull_request.title, 'create-typescript-app') }}",
25-
name: "CTA Transitions",
2686
steps: [
27-
{ run: "pnpx create-typescript-app" },
2887
{
2988
uses: resolveUses(
30-
"stefanzweifel/git-auto-commit-action",
31-
"v5",
89+
"actions/checkout",
90+
"v4",
3291
options.workflowsVersions,
3392
),
3493
with: {
35-
commit_author: "The Friendly Bingo Bot <[email protected]>",
36-
commit_message:
37-
"Check in changes from re-running npx create-typescript-app",
38-
commit_user_email: "[email protected]",
39-
commit_user_name: "The Friendly Bingo Bot",
94+
"fetch-depth": 0,
95+
ref: "${{github.event.pull_request.head.ref}}",
96+
repository:
97+
"${{github.event.pull_request.head.repo.full_name}}",
98+
token: "${{ secrets.ACCESS_TOKEN }}",
4099
},
41100
},
42101
{
43-
uses: resolveUses(
44-
"mshick/add-pr-comment",
45-
"v2",
46-
options.workflowsVersions,
47-
),
48-
with: {
49-
issue: "${{ github.event.pull_request.number }}",
50-
message: [
51-
"|",
52-
"🤖 Beep boop! I ran `npx create-typescript-app` and found same changes.",
53-
"Please review the latest commit to see if you want to merge it.",
54-
"Cheers! 💝",
55-
"",
56-
"> This change was automatically made in CI to keep your repository up-to-date with the templating in [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).",
57-
"> If you want to opt out of these automatic updates, delete the `.github/workflows/cta-transitions.yml` file on your `main` branch.",
58-
].join("\n"),
59-
"repo-token": "${{ secrets.ACCESS_TOKEN }}",
60-
},
102+
id: "check",
103+
if: `(github.actor == '${options.owner}' || github.actor == 'renovate[bot]') && startsWith(github.head_ref, 'renovate/') && contains(github.event.pull_request.title, 'create-typescript-app')`,
104+
uses: "./.github/actions/transition",
105+
},
106+
{
107+
if: "steps.check.outcome == 'skipped'",
108+
run: "echo 'Skipping transition mode because the PR does not appear to be an automated or owner-created update to create-typescript-app.'",
61109
},
62110
],
63-
},
64-
],
65-
}),
66-
blockPackageJson({
67-
properties: {
68-
devDependencies: {
69-
"create-typescript-app": packageData.version,
70-
},
111+
}),
71112
},
72-
}),
73-
],
113+
},
114+
},
74115
};
75116
},
76117
});

0 commit comments

Comments
 (0)