-
Notifications
You must be signed in to change notification settings - Fork 20.3k
smarter changelog #20138
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
Merged
Merged
smarter changelog #20138
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,261 +1,76 @@ | ||
| #!/usr/bin/env bun | ||
|
|
||
| import { $ } from "bun" | ||
| import { rm } from "fs/promises" | ||
| import path from "path" | ||
| import { parseArgs } from "util" | ||
|
|
||
| type Release = { | ||
| tag_name: string | ||
| draft: boolean | ||
| } | ||
|
|
||
| type Commit = { | ||
| hash: string | ||
| author: string | null | ||
| message: string | ||
| areas: Set<string> | ||
| } | ||
|
|
||
| type User = Map<string, Set<string>> | ||
| type Diff = { | ||
| sha: string | ||
| login: string | null | ||
| message: string | ||
| } | ||
|
|
||
| const repo = process.env.GH_REPO ?? "anomalyco/opencode" | ||
| const bot = ["actions-user", "opencode", "opencode-agent[bot]"] | ||
| const team = [ | ||
| ...(await Bun.file(new URL("../.github/TEAM_MEMBERS", import.meta.url)) | ||
| .text() | ||
| .then((x) => x.split(/\r?\n/).map((x) => x.trim())) | ||
| .then((x) => x.filter((x) => x && !x.startsWith("#")))), | ||
| ...bot, | ||
| ] | ||
| const order = ["Core", "TUI", "Desktop", "SDK", "Extensions"] as const | ||
| const sections = { | ||
| core: "Core", | ||
| tui: "TUI", | ||
| app: "Desktop", | ||
| tauri: "Desktop", | ||
| sdk: "SDK", | ||
| plugin: "SDK", | ||
| "extensions/zed": "Extensions", | ||
| "extensions/vscode": "Extensions", | ||
| github: "Extensions", | ||
| } as const | ||
|
|
||
| function ref(input: string) { | ||
| if (input === "HEAD") return input | ||
| if (input.startsWith("v")) return input | ||
| if (input.match(/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/)) return `v${input}` | ||
| return input | ||
| } | ||
|
|
||
| async function latest() { | ||
| const data = await $`gh api "/repos/${repo}/releases?per_page=100"`.json() | ||
| const release = (data as Release[]).find((item) => !item.draft) | ||
| if (!release) throw new Error("No releases found") | ||
| return release.tag_name.replace(/^v/, "") | ||
| } | ||
|
|
||
| async function diff(base: string, head: string) { | ||
| const list: Diff[] = [] | ||
| for (let page = 1; ; page++) { | ||
| const text = | ||
| await $`gh api "/repos/${repo}/compare/${base}...${head}?per_page=100&page=${page}" --jq '.commits[] | {sha: .sha, login: .author.login, message: .commit.message}'`.text() | ||
| const batch = text | ||
| .split("\n") | ||
| .filter(Boolean) | ||
| .map((line) => JSON.parse(line) as Diff) | ||
| if (batch.length === 0) break | ||
| list.push(...batch) | ||
| if (batch.length < 100) break | ||
| } | ||
| return list | ||
| } | ||
|
|
||
| function section(areas: Set<string>) { | ||
| const priority = ["core", "tui", "app", "tauri", "sdk", "plugin", "extensions/zed", "extensions/vscode", "github"] | ||
| for (const area of priority) { | ||
| if (areas.has(area)) return sections[area as keyof typeof sections] | ||
| } | ||
| return "Core" | ||
| } | ||
|
|
||
| function reverted(commits: Commit[]) { | ||
| const seen = new Map<string, Commit>() | ||
|
|
||
| for (const commit of commits) { | ||
| const match = commit.message.match(/^Revert "(.+)"$/) | ||
| if (match) { | ||
| const msg = match[1]! | ||
| if (seen.has(msg)) seen.delete(msg) | ||
| else seen.set(commit.message, commit) | ||
| continue | ||
| } | ||
|
|
||
| const revert = `Revert "${commit.message}"` | ||
| if (seen.has(revert)) { | ||
| seen.delete(revert) | ||
| continue | ||
| } | ||
|
|
||
| seen.set(commit.message, commit) | ||
| } | ||
|
|
||
| return [...seen.values()] | ||
| } | ||
|
|
||
| async function commits(from: string, to: string) { | ||
| const base = ref(from) | ||
| const head = ref(to) | ||
|
|
||
| const data = new Map<string, { login: string | null; message: string }>() | ||
| for (const item of await diff(base, head)) { | ||
| data.set(item.sha, { login: item.login, message: item.message.split("\n")[0] ?? "" }) | ||
| } | ||
|
|
||
| const log = | ||
| await $`git log ${base}..${head} --format=%H -- packages/opencode packages/sdk packages/plugin packages/desktop packages/app sdks/vscode packages/extensions github`.text() | ||
|
|
||
| const list: Commit[] = [] | ||
| for (const hash of log.split("\n").filter(Boolean)) { | ||
| const item = data.get(hash) | ||
| if (!item) continue | ||
| if (item.message.match(/^(ignore:|test:|chore:|ci:|release:)/i)) continue | ||
|
|
||
| const diff = await $`git diff-tree --no-commit-id --name-only -r ${hash}`.text() | ||
| const areas = new Set<string>() | ||
|
|
||
| for (const file of diff.split("\n").filter(Boolean)) { | ||
| if (file.startsWith("packages/opencode/src/cli/cmd/")) areas.add("tui") | ||
| else if (file.startsWith("packages/opencode/")) areas.add("core") | ||
| else if (file.startsWith("packages/desktop/src-tauri/")) areas.add("tauri") | ||
| else if (file.startsWith("packages/desktop/") || file.startsWith("packages/app/")) areas.add("app") | ||
| else if (file.startsWith("packages/sdk/") || file.startsWith("packages/plugin/")) areas.add("sdk") | ||
| else if (file.startsWith("packages/extensions/")) areas.add("extensions/zed") | ||
| else if (file.startsWith("sdks/vscode/") || file.startsWith("github/")) areas.add("extensions/vscode") | ||
| } | ||
|
|
||
| if (areas.size === 0) continue | ||
|
|
||
| list.push({ | ||
| hash: hash.slice(0, 7), | ||
| author: item.login, | ||
| message: item.message, | ||
| areas, | ||
| }) | ||
| } | ||
|
|
||
| return reverted(list) | ||
| } | ||
|
|
||
| async function contributors(from: string, to: string) { | ||
| const base = ref(from) | ||
| const head = ref(to) | ||
|
|
||
| const users: User = new Map() | ||
| for (const item of await diff(base, head)) { | ||
| const title = item.message.split("\n")[0] ?? "" | ||
| if (!item.login || team.includes(item.login)) continue | ||
| if (title.match(/^(ignore:|test:|chore:|ci:|release:)/i)) continue | ||
| if (!users.has(item.login)) users.set(item.login, new Set()) | ||
| users.get(item.login)!.add(title) | ||
| } | ||
|
|
||
| return users | ||
| } | ||
|
|
||
| async function published(to: string) { | ||
| if (to === "HEAD") return | ||
| const body = await $`gh release view ${ref(to)} --repo ${repo} --json body --jq .body`.text().catch(() => "") | ||
| if (!body) return | ||
|
|
||
| const lines = body.split(/\r?\n/) | ||
| const start = lines.findIndex((line) => line.startsWith("**Thank you to ")) | ||
| if (start < 0) return | ||
| return lines.slice(start).join("\n").trim() | ||
| } | ||
|
|
||
| async function thanks(from: string, to: string, reuse: boolean) { | ||
| const release = reuse ? await published(to) : undefined | ||
| if (release) return release.split(/\r?\n/) | ||
|
|
||
| const users = await contributors(from, to) | ||
| if (users.size === 0) return [] | ||
|
|
||
| const lines = [`**Thank you to ${users.size} community contributor${users.size > 1 ? "s" : ""}:**`] | ||
| for (const [name, commits] of users) { | ||
| lines.push(`- @${name}:`) | ||
| for (const commit of commits) lines.push(` - ${commit}`) | ||
| } | ||
| return lines | ||
| } | ||
|
|
||
| function format(from: string, to: string, list: Commit[], thanks: string[]) { | ||
| const grouped = new Map<string, string[]>() | ||
| for (const title of order) grouped.set(title, []) | ||
|
|
||
| for (const commit of list) { | ||
| const title = section(commit.areas) | ||
| const attr = commit.author && !team.includes(commit.author) ? ` (@${commit.author})` : "" | ||
| grouped.get(title)!.push(`- \`${commit.hash}\` ${commit.message}${attr}`) | ||
| } | ||
|
|
||
| const lines = [`Last release: ${ref(from)}`, `Target ref: ${to}`, ""] | ||
|
|
||
| if (list.length === 0) { | ||
| lines.push("No notable changes.") | ||
| } | ||
|
|
||
| for (const title of order) { | ||
| const entries = grouped.get(title) | ||
| if (!entries || entries.length === 0) continue | ||
| lines.push(`## ${title}`) | ||
| lines.push(...entries) | ||
| lines.push("") | ||
| } | ||
|
|
||
| if (thanks.length > 0) { | ||
| if (lines.at(-1) !== "") lines.push("") | ||
| lines.push("## Community Contributors Input") | ||
| lines.push("") | ||
| lines.push(...thanks) | ||
| } | ||
|
|
||
| if (lines.at(-1) === "") lines.pop() | ||
| return lines.join("\n") | ||
| } | ||
|
|
||
| if (import.meta.main) { | ||
| const { values } = parseArgs({ | ||
| args: Bun.argv.slice(2), | ||
| options: { | ||
| from: { type: "string", short: "f" }, | ||
| to: { type: "string", short: "t", default: "HEAD" }, | ||
| help: { type: "boolean", short: "h", default: false }, | ||
| }, | ||
| }) | ||
|
|
||
| if (values.help) { | ||
| console.log(` | ||
| const root = path.resolve(import.meta.dir, "..") | ||
| const file = path.join(root, "UPCOMING_CHANGELOG.md") | ||
| const { values, positionals } = parseArgs({ | ||
| args: Bun.argv.slice(2), | ||
| options: { | ||
| from: { type: "string", short: "f" }, | ||
| to: { type: "string", short: "t" }, | ||
| variant: { type: "string", default: "low" }, | ||
| quiet: { type: "boolean", default: false }, | ||
| print: { type: "boolean", default: false }, | ||
| help: { type: "boolean", short: "h", default: false }, | ||
| }, | ||
| allowPositionals: true, | ||
| }) | ||
| const args = [...positionals] | ||
|
|
||
| if (values.from) args.push("--from", values.from) | ||
| if (values.to) args.push("--to", values.to) | ||
|
|
||
| if (values.help) { | ||
| console.log(` | ||
| Usage: bun script/changelog.ts [options] | ||
|
|
||
| Generates UPCOMING_CHANGELOG.md by running the opencode changelog command. | ||
|
|
||
| Options: | ||
| -f, --from <version> Starting version (default: latest non-draft GitHub release) | ||
| -t, --to <ref> Ending ref (default: HEAD) | ||
| --variant <name> Thinking variant for opencode run (default: low) | ||
| --quiet Suppress opencode command output unless it fails | ||
| --print Print the generated UPCOMING_CHANGELOG.md after success | ||
| -h, --help Show this help message | ||
|
|
||
| Examples: | ||
| bun script/changelog.ts | ||
| bun script/changelog.ts --from 1.0.200 | ||
| bun script/changelog.ts -f 1.0.200 -t 1.0.205 | ||
| `) | ||
| process.exit(0) | ||
| } | ||
| process.exit(0) | ||
| } | ||
|
|
||
| const to = values.to! | ||
| const from = values.from ?? (await latest()) | ||
| const list = await commits(from, to) | ||
| console.log(format(from, to, list, await thanks(from, to, !values.from))) | ||
| await rm(file, { force: true }) | ||
|
|
||
| const quiet = values.quiet | ||
| const cmd = ["opencode", "run"] | ||
| cmd.push("--variant", values.variant) | ||
| cmd.push("--command", "changelog", "--", ...args) | ||
|
|
||
| const proc = Bun.spawn(cmd, { | ||
| cwd: root, | ||
| stdin: "inherit", | ||
| stdout: quiet ? "pipe" : "inherit", | ||
| stderr: quiet ? "pipe" : "inherit", | ||
| }) | ||
|
|
||
| const [out, err] = quiet | ||
| ? await Promise.all([new Response(proc.stdout).text(), new Response(proc.stderr).text()]) | ||
| : ["", ""] | ||
| const code = await proc.exited | ||
| if (code === 0) { | ||
| if (values.print) process.stdout.write(await Bun.file(file).text()) | ||
| process.exit(0) | ||
|
Hona marked this conversation as resolved.
|
||
| } | ||
|
|
||
| if (quiet) { | ||
| if (out) process.stdout.write(out) | ||
| if (err) process.stderr.write(err) | ||
| } | ||
|
|
||
| process.exit(code) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.