Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

automate release of quick-edit when workers-types is updated #6852

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: "Miniflare - Generate changesets for dependabot PRs"
name: "Generate changesets for dependabot PRs"
on:
pull_request_target:
paths:
- "packages/miniflare/package.json"
- "packages/quick-edit-extension/package.json"

jobs:
generate-changeset:
Expand All @@ -25,5 +26,5 @@ jobs:
git config --global user.email [email protected]
git config --global user.name 'Wrangler automated PR updater'

- name: Generate Miniflare changesets
run: node -r esbuild-register tools/dependabot/generate-dependabot-pr-changesets.ts ${{ github.event.number }} miniflare packages/miniflare/package.json dependabot-update
- name: Generate Miniflare changeset
run: node -r esbuild-register tools/dependabot/generate-dependabot-pr-changesets.ts ${{ github.event.number }} miniflare quick-edit-extension
1 change: 1 addition & 0 deletions packages/quick-edit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"devDependencies": {
"@cloudflare/workers-tsconfig": "workspace:*",
"concurrently": "^8.2.2",
"quick-edit-extension": "workspace:*",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will cause changesets to bump the version of quick-edit when quick-edit-extension's version is bumped which will then cause it to be released with other packages/workers

"tsx": "^3.12.8",
"wrangler": "workspace:*"
},
Expand Down
9 changes: 9 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ import { writeFileSync } from "fs";
import dedent from "ts-dedent";
import { beforeEach, describe, it, vitest } from "vitest";
import {
commitAndPush,
generateChangesetHeader,
generateCommitMessage,
getPackageJsonDiff,
gitCommit,
gitPush,
parseDiffForChanges,
writeChangeSet,
} from "../generate-dependabot-pr-changesets";
Expand Down Expand Up @@ -157,10 +158,10 @@ describe("writeChangeSet()", () => {
| some-package | ^0.0.1 | ^0.0.2 |
| @namespace/some-package | 1.3.4 | 1.4.5 |
`;
writeChangeSet("some-prefix", "1234", header, body);
writeChangeSet("1234", "pkgName", header, body);
expect(writeFileSync).toHaveBeenCalledOnce();
expect((writeFileSync as Mock).mock.lastCall?.[0]).toMatchInlineSnapshot(
`".changeset/some-prefix-1234.md"`
`".changeset/dependabot-update-pkgName-1234.md"`
);
expect((writeFileSync as Mock).mock.lastCall?.[1]).toMatchInlineSnapshot(`
"---
Expand Down Expand Up @@ -190,7 +191,8 @@ describe("commitAndPush()", () => {
| ----------------------- | ------ | ------ |
| some-package | ^0.0.1 | ^0.0.2 |
| @namespace/some-package | 1.3.4 | 1.4.5 |`;
commitAndPush(commitMessage);
gitCommit(commitMessage);
gitPush();
expect(spawnSync).toHaveBeenCalledTimes(3);
expect((spawnSync as Mock).mock.calls[0]).toMatchInlineSnapshot(`
[
Expand Down Expand Up @@ -242,8 +244,8 @@ describe("commitAndPush()", () => {
args[0] === "push" ? new Error("Failed to push") : undefined;
return { output: [], error };
});
expect(() =>
commitAndPush("commit message")
).toThrowErrorMatchingInlineSnapshot(`[Error: Failed to push]`);
expect(() => gitPush()).toThrowErrorMatchingInlineSnapshot(
`[Error: Failed to push]`
);
});
});
49 changes: 23 additions & 26 deletions tools/dependabot/generate-dependabot-pr-changesets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ if (require.main === module) {

type Args = {
prNumber: string;
packageName: string;
packageJSONPath: string;
changesetPrefix: string;
packageNames: string[];
};

function processArgs(): Args {
Expand All @@ -48,33 +46,30 @@ function processArgs(): Args {
}
return {
prNumber: args[0],
packageName: args[1],
packageJSONPath: args[2],
changesetPrefix: args[3],
packageNames: args.slice(1),
};
}

function main({
prNumber,
packageName,
packageJSONPath,
changesetPrefix,
}: Args): void {
const diffLines = getPackageJsonDiff(resolve(packageJSONPath));
const changes = parseDiffForChanges(diffLines);
if (changes.size === 0) {
console.warn(dedent`
function main({ prNumber, packageNames }: Args): void {
for (const packageName of packageNames) {
const packageJSONPath = `packages/${packageName}/package.json`;
const diffLines = getPackageJsonDiff(resolve(packageJSONPath));
const changes = parseDiffForChanges(diffLines);
if (changes.size === 0) {
console.warn(dedent`
WARN: No dependency changes detected for "${packageName}".
`);
return;
}
const changesetHeader = generateChangesetHeader(packageName);
const commitMessage = generateCommitMessage(packageName, changes);
console.log(dedent`
return;
}
const changesetHeader = generateChangesetHeader(packageName);
const commitMessage = generateCommitMessage(packageName, changes);
console.log(dedent`
INFO: Writing changeset with the following commit message
${commitMessage}`);
writeChangeSet(changesetPrefix, prNumber, changesetHeader, commitMessage);
commitAndPush(commitMessage);
writeChangeSet(prNumber, packageName, changesetHeader, commitMessage);
gitCommit(commitMessage);
}
gitPush();
}

export function getPackageJsonDiff(packageJSONPath: string): string[] {
Expand Down Expand Up @@ -158,20 +153,22 @@ export function generateCommitMessage(
}

export function writeChangeSet(
changesetPrefix: string,
prNumber: string,
packageName: string,
changesetHeader: string,
commitMessage: string
): void {
writeFileSync(
`.changeset/${changesetPrefix}-${prNumber}.md`,
`.changeset/dependabot-update-${packageName}-${prNumber}.md`,
changesetHeader + "\n\n" + commitMessage + "\n"
);
}

export function commitAndPush(commitMessage: string): void {
export function gitCommit(commitMessage: string): void {
executeCommand("git", ["add", ".changeset"]);
executeCommand("git", ["commit", "-m", commitMessage]);
}
export function gitPush(): void {
executeCommand("git", ["push"]);
}

Expand Down
Loading