1cc0ff44 Andy McCall 1 month ago ↶ 1
// The Releases view (spec §8.2): each repository's releases with their
2
// assets, and drafting a release from a tag with notes from history.
3
4
import * as vscode from "vscode";
5
import type * as api from "./hubapi";
6
import { HubAuth } from "./auth";
7
import { looksPrerelease, releaseNotes } from "./hub";
8
import type { HubRepo } from "./proposals";
9
10
type Node =
11
| { kind: "repo"; repo: HubRepo }
12
| { kind: "release"; repo: HubRepo; r: api.Release }
13
| { kind: "asset"; repo: HubRepo; r: api.Release; name: string; url: string; size?: number; downloads?: number };
14
15
export type ReleaseNode = Extract<Node, { kind: "release" }>;
16
17
export class ReleasesProvider implements vscode.TreeDataProvider<Node> {
18
private readonly emitter = new vscode.EventEmitter<void>();
19
readonly onDidChangeTreeData = this.emitter.event;
20
21
constructor(
22
private readonly repos: () => Promise<HubRepo[]>,
23
private readonly auth: HubAuth,
24
) {}
25
26
refresh(): void {
27
this.emitter.fire();
28
}
29
30
getTreeItem(node: Node): vscode.TreeItem {
31
switch (node.kind) {
32
case "repo": {
33
const item = new vscode.TreeItem(`${node.repo.owner}/${node.repo.name}`, vscode.TreeItemCollapsibleState.Expanded);
34
item.iconPath = new vscode.ThemeIcon("repo");
35
item.contextValue = "releaseRepo";
36
return item;
37
}
38
case "release": {
39
const r = node.r;
40
const item = new vscode.TreeItem(r.title || r.tag, vscode.TreeItemCollapsibleState.Collapsed);
41
item.description = [r.tag, r.latest ? "latest" : "", r.prerelease ? "pre-release" : "", new Date(r.created_ms).toLocaleDateString()].filter(Boolean).join(" · ");
42
item.iconPath = new vscode.ThemeIcon(r.prerelease ? "beaker" : "tag");
43
item.tooltip = new vscode.MarkdownString(`**${r.title || r.tag}** · ${r.tag} by ${r.author}\n\n${r.notes.slice(0, 600)}`);
44
item.contextValue = "release";
45
item.command = { title: "Open", command: "vscode.open", arguments: [vscode.Uri.parse(r.url)] };
46
return item;
47
}
48
case "asset": {
49
const item = new vscode.TreeItem(node.name, vscode.TreeItemCollapsibleState.None);
50
item.description = node.size !== undefined ? `${formatSize(node.size)} · ${node.downloads ?? 0} downloads` : "source archive";
51
item.iconPath = new vscode.ThemeIcon(node.size !== undefined ? "package" : "file-zip");
52
item.command = { title: "Download", command: "vscode.open", arguments: [vscode.Uri.parse(node.url)] };
53
return item;
54
}
55
}
56
}
57
58
async getChildren(node?: Node): Promise<Node[]> {
59
if (!node) {
60
return (await this.repos()).map((repo) => ({ kind: "repo", repo }));
61
}
62
if (node.kind === "repo") {
63
try {
64
const list = await this.auth.clientFor(node.repo.base).releases(node.repo.owner, node.repo.name);
65
return list.map((r) => ({ kind: "release", repo: node.repo, r }));
66
} catch (e) {
092b8bf9 Andy McCall 1 month ago ↶ 67
void vscode.window.showWarningMessage(`OxygenHub: ${(e as Error).message}`);
1cc0ff44 Andy McCall 1 month ago ↶ 68
return [];
69
}
70
}
71
if (node.kind === "release") {
72
const assets: Node[] = node.r.assets.map((a) => ({ kind: "asset", repo: node.repo, r: node.r, name: a.name, url: a.url, size: a.size, downloads: a.downloads }));
73
const archives: Node[] = node.r.archives.map((url) => ({ kind: "asset", repo: node.repo, r: node.r, name: url.split("/").pop() ?? url, url }));
74
return [...assets, ...archives];
75
}
76
return [];
77
}
78
}
79
80
function formatSize(n: number): string {
81
return n >= 1 << 20 ? `${(n / (1 << 20)).toFixed(1)} MiB` : n >= 1024 ? `${(n / 1024).toFixed(1)} KiB` : `${n} B`;
82
}
83
84
/** Draft a release: a tag without one, a title, notes from the changes since the last release. */
85
export async function draftRelease(auth: HubAuth, repo: HubRepo): Promise<api.Release | undefined> {
86
const client = auth.clientFor(repo.base);
87
const [tags, releases] = await Promise.all([client.tags(repo.owner, repo.name), client.releases(repo.owner, repo.name)]);
88
const released = new Set(releases.map((r) => r.tag));
89
const open = tags.filter((t) => !released.has(t.name));
90
if (!open.length) {
092b8bf9 Andy McCall 1 month ago ↶ 91
void vscode.window.showInformationMessage(`OxygenHub: every tag of ${repo.owner}/${repo.name} has a release. Tag a state with \`oxy tag create\` and push it first.`);
1cc0ff44 Andy McCall 1 month ago ↶ 92
return undefined;
93
}
94
const pick = await vscode.window.showQuickPick(
95
open.map((t) => ({ label: t.name, description: t.message.split("\n")[0], detail: t.signer ? "signed" : undefined, t })),
96
{ placeHolder: "Tag to release" },
97
);
98
if (!pick) {
99
return undefined;
100
}
101
const title = await vscode.window.showInputBox({ prompt: "Release title", value: pick.t.message.split("\n")[0] || pick.label });
102
if (title === undefined) {
103
return undefined;
104
}
105
const previous = releases.filter((r) => !r.prerelease).sort((a, b) => b.created_ms - a.created_ms)[0];
106
const current = await client.history(repo.owner, repo.name, pick.label, 500);
107
const before = previous ? await client.history(repo.owner, repo.name, previous.tag, 500) : { changes: [] as api.ChangeSummary[] };
108
const notes = releaseNotes(current.changes, before.changes, previous?.tag);
109
const pre = await vscode.window.showQuickPick(
110
[
111
{ label: "Release", pre: false },
112
{ label: "Pre-release", pre: true },
113
].sort((a) => (a.pre === looksPrerelease(pick.label) ? -1 : 1)),
114
{ placeHolder: "Kind" },
115
);
116
if (!pre) {
117
return undefined;
118
}
119
return client.createRelease(repo.owner, repo.name, { tag: pick.label, title: title || pick.label, notes, prerelease: pre.pre });
120
}