@softure-ai/ci-usage 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/LICENSE +21 -0
- package/README.md +131 -2
- package/dist/billing.d.ts +37 -0
- package/dist/billing.d.ts.map +1 -0
- package/dist/billing.js +83 -0
- package/dist/billing.js.map +1 -0
- package/dist/cli/command.d.ts +33 -0
- package/dist/cli/command.d.ts.map +1 -0
- package/dist/cli/command.js +209 -0
- package/dist/cli/command.js.map +1 -0
- package/dist/cli/main.d.ts +3 -0
- package/dist/cli/main.d.ts.map +1 -0
- package/dist/cli/main.js +10 -0
- package/dist/cli/main.js.map +1 -0
- package/dist/collect.d.ts +51 -0
- package/dist/collect.d.ts.map +1 -0
- package/dist/collect.js +224 -0
- package/dist/collect.js.map +1 -0
- package/dist/github.d.ts +41 -0
- package/dist/github.d.ts.map +1 -0
- package/dist/github.js +91 -0
- package/dist/github.js.map +1 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -0
- package/dist/messages/en.d.ts +51 -0
- package/dist/messages/en.d.ts.map +1 -0
- package/dist/messages/en.js +51 -0
- package/dist/messages/en.js.map +1 -0
- package/dist/messages/index.d.ts +11 -0
- package/dist/messages/index.d.ts.map +1 -0
- package/dist/messages/index.js +13 -0
- package/dist/messages/index.js.map +1 -0
- package/dist/prices.d.ts +32 -0
- package/dist/prices.d.ts.map +1 -0
- package/dist/prices.js +52 -0
- package/dist/prices.js.map +1 -0
- package/dist/publish.d.ts +29 -0
- package/dist/publish.d.ts.map +1 -0
- package/dist/publish.js +91 -0
- package/dist/publish.js.map +1 -0
- package/dist/report.d.ts +57 -0
- package/dist/report.d.ts.map +1 -0
- package/dist/report.js +168 -0
- package/dist/report.js.map +1 -0
- package/dist/runner.d.ts +28 -0
- package/dist/runner.d.ts.map +1 -0
- package/dist/runner.js +55 -0
- package/dist/runner.js.map +1 -0
- package/dist/usage.d.ts +67 -0
- package/dist/usage.d.ts.map +1 -0
- package/dist/usage.js +112 -0
- package/dist/usage.js.map +1 -0
- package/examples/ci-usage.yml +34 -0
- package/package.json +42 -4
- package/src/billing.ts +102 -0
- package/src/cli/command.ts +218 -0
- package/src/cli/main.ts +10 -0
- package/src/collect.ts +266 -0
- package/src/github.ts +113 -0
- package/src/index.ts +10 -0
- package/src/messages/en.ts +52 -0
- package/src/messages/index.ts +15 -0
- package/src/prices.ts +74 -0
- package/src/publish.ts +95 -0
- package/src/report.ts +215 -0
- package/src/runner.ts +64 -0
- package/src/usage.ts +192 -0
package/dist/prices.d.ts
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { GithubSku, RunnerClass } from "./runner.js";
|
|
2
|
+
export interface PriceTable {
|
|
3
|
+
/** USD per minute of GitHub's standard hosted runners, by billing SKU. */
|
|
4
|
+
github: Record<GithubSku, number>;
|
|
5
|
+
/** USD per minute of Ubicloud standard runners (x64 and arm64 cost the same), by vCPU count. */
|
|
6
|
+
ubicloudStandard: Record<string, number>;
|
|
7
|
+
/** USD per minute of Ubicloud premium runners, by vCPU count. */
|
|
8
|
+
ubicloudPremium: Record<string, number>;
|
|
9
|
+
/** USD per minute by exact runner label; wins over everything above (larger GitHub runners, own runners). */
|
|
10
|
+
labels: Record<string, number>;
|
|
11
|
+
/** Where the built-in numbers come from and when they were checked. */
|
|
12
|
+
source: string;
|
|
13
|
+
checkedOn: string;
|
|
14
|
+
}
|
|
15
|
+
export declare const DEFAULT_PRICES: PriceTable;
|
|
16
|
+
export type PricesResult = {
|
|
17
|
+
ok: true;
|
|
18
|
+
prices: PriceTable;
|
|
19
|
+
} | {
|
|
20
|
+
ok: false;
|
|
21
|
+
error: string;
|
|
22
|
+
};
|
|
23
|
+
/** Merges a JSON object of `label → USD per minute` over the built-in table. An empty value keeps the table. */
|
|
24
|
+
export declare function parsePriceOverrides(json: string | undefined, base?: PriceTable): PricesResult;
|
|
25
|
+
export interface PriceOptions {
|
|
26
|
+
prices: PriceTable;
|
|
27
|
+
/** Ubicloud premium is an account setting the job does not show; true prices every Ubicloud minute as premium. */
|
|
28
|
+
ubicloudPremium: boolean;
|
|
29
|
+
}
|
|
30
|
+
/** USD per minute of one runner, or null when neither the table nor the caller knows it. */
|
|
31
|
+
export declare function getMinutePrice(runner: RunnerClass, options: PriceOptions): number | null;
|
|
32
|
+
//# sourceMappingURL=prices.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prices.d.ts","sourceRoot":"","sources":["../src/prices.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAClC,gGAAgG;IAChG,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,iEAAiE;IACjE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,6GAA6G;IAC7G,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,uEAAuE;IACvE,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,cAAc,EAAE,UAc5B,CAAC;AAKF,MAAM,MAAM,YAAY,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3F,gHAAgH;AAChH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,GAAE,UAA2B,GAAG,YAAY,CAW7G;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,UAAU,CAAC;IACnB,kHAAkH;IAClH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,4FAA4F;AAC5F,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI,CAaxF"}
|
package/dist/prices.js
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
// What a runner minute costs, from the providers' published price lists, with the caller's overrides on top.
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
export const DEFAULT_PRICES = {
|
|
4
|
+
github: {
|
|
5
|
+
actions_linux_slim: 0.002,
|
|
6
|
+
actions_linux: 0.006,
|
|
7
|
+
actions_linux_arm: 0.005,
|
|
8
|
+
actions_windows: 0.01,
|
|
9
|
+
actions_windows_arm: 0.01,
|
|
10
|
+
actions_macos: 0.062,
|
|
11
|
+
},
|
|
12
|
+
ubicloudStandard: { "2": 0.00125, "4": 0.0025, "8": 0.005, "16": 0.01, "30": 0.01875 },
|
|
13
|
+
ubicloudPremium: { "2": 0.002, "4": 0.004, "8": 0.008, "16": 0.016, "30": 0.03 },
|
|
14
|
+
labels: {},
|
|
15
|
+
source: "https://docs.github.com/en/billing/reference/actions-runner-pricing, https://ubicloud.com/docs/about/pricing",
|
|
16
|
+
checkedOn: "2026-11-18",
|
|
17
|
+
};
|
|
18
|
+
const PRICE = z.number().finite().nonnegative();
|
|
19
|
+
const OVERRIDES = z.record(z.string().min(1), PRICE);
|
|
20
|
+
/** Merges a JSON object of `label → USD per minute` over the built-in table. An empty value keeps the table. */
|
|
21
|
+
export function parsePriceOverrides(json, base = DEFAULT_PRICES) {
|
|
22
|
+
if (json === undefined || json.trim() === "")
|
|
23
|
+
return { ok: true, prices: base };
|
|
24
|
+
let value;
|
|
25
|
+
try {
|
|
26
|
+
value = JSON.parse(json);
|
|
27
|
+
}
|
|
28
|
+
catch {
|
|
29
|
+
return { ok: false, error: `--prices is not JSON: ${json}` };
|
|
30
|
+
}
|
|
31
|
+
const parsed = OVERRIDES.safeParse(value);
|
|
32
|
+
if (!parsed.success)
|
|
33
|
+
return { ok: false, error: `--prices must be a JSON object of runner label to USD per minute, such as {"my-runner":0.004}` };
|
|
34
|
+
return { ok: true, prices: { ...base, labels: { ...base.labels, ...parsed.data } } };
|
|
35
|
+
}
|
|
36
|
+
/** USD per minute of one runner, or null when neither the table nor the caller knows it. */
|
|
37
|
+
export function getMinutePrice(runner, options) {
|
|
38
|
+
const byLabel = options.prices.labels[runner.label];
|
|
39
|
+
if (byLabel !== undefined)
|
|
40
|
+
return byLabel;
|
|
41
|
+
switch (runner.provider) {
|
|
42
|
+
case "github-hosted":
|
|
43
|
+
return options.prices.github[runner.sku];
|
|
44
|
+
case "ubicloud": {
|
|
45
|
+
const table = options.ubicloudPremium ? options.prices.ubicloudPremium : options.prices.ubicloudStandard;
|
|
46
|
+
return table[String(runner.vcpu)] ?? null;
|
|
47
|
+
}
|
|
48
|
+
case "self-hosted":
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=prices.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prices.js","sourceRoot":"","sources":["../src/prices.ts"],"names":[],"mappings":"AAAA,6GAA6G;AAC7G,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiBxB,MAAM,CAAC,MAAM,cAAc,GAAe;IACxC,MAAM,EAAE;QACN,kBAAkB,EAAE,KAAK;QACzB,aAAa,EAAE,KAAK;QACpB,iBAAiB,EAAE,KAAK;QACxB,eAAe,EAAE,IAAI;QACrB,mBAAmB,EAAE,IAAI;QACzB,aAAa,EAAE,KAAK;KACrB;IACD,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE;IACtF,eAAe,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;IAChF,MAAM,EAAE,EAAE;IACV,MAAM,EAAE,8GAA8G;IACtH,SAAS,EAAE,YAAY;CACxB,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;AAChD,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAIrD,gHAAgH;AAChH,MAAM,UAAU,mBAAmB,CAAC,IAAwB,EAAE,IAAI,GAAe,cAAc;IAC7F,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAChF,IAAI,KAAc,CAAC;IACnB,IAAI,CAAC;QACH,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,IAAI,EAAE,EAAE,CAAC;IAC/D,CAAC;IACD,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,+FAA+F,EAAE,CAAC;IAClJ,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC;AACvF,CAAC;AAQD,4FAA4F;AAC5F,MAAM,UAAU,cAAc,CAAC,MAAmB,EAAE,OAAqB;IACvE,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpD,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC;IAC1C,QAAQ,MAAM,CAAC,QAAQ,EAAE,CAAC;QACxB,KAAK,eAAe;YAClB,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3C,KAAK,UAAU,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;YACzG,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC;QAC5C,CAAC;QACD,KAAK,aAAa;YAChB,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { GithubClient } from "./github.js";
|
|
2
|
+
import { type CiUsageMessages } from "./messages/index.js";
|
|
3
|
+
import { type CiUsageReport } from "./report.js";
|
|
4
|
+
export declare const ISSUE_LABEL = "ci-usage";
|
|
5
|
+
/** GitHub refuses an issue body above 65,536 characters; a margin keeps the closing lines. */
|
|
6
|
+
export declare const MAX_BODY = 65000;
|
|
7
|
+
export type PublishResult = {
|
|
8
|
+
ok: true;
|
|
9
|
+
issue: number;
|
|
10
|
+
url: string;
|
|
11
|
+
created: boolean;
|
|
12
|
+
} | {
|
|
13
|
+
ok: false;
|
|
14
|
+
error: string;
|
|
15
|
+
};
|
|
16
|
+
/** The issue body: the Markdown report, then the JSON in a collapsed block when the whole still fits. */
|
|
17
|
+
export declare function buildIssueBody(markdown: string, report: CiUsageReport, messages?: CiUsageMessages): string;
|
|
18
|
+
export declare function buildComment(report: CiUsageReport, runUrl: string, messages?: CiUsageMessages): string;
|
|
19
|
+
export interface PublishOptions {
|
|
20
|
+
client: GithubClient;
|
|
21
|
+
repository: string;
|
|
22
|
+
report: CiUsageReport;
|
|
23
|
+
markdown: string;
|
|
24
|
+
runUrl: string;
|
|
25
|
+
messages?: CiUsageMessages;
|
|
26
|
+
}
|
|
27
|
+
/** Creates the issue the first time, replaces its body afterwards, and comments the run's totals. */
|
|
28
|
+
export declare function publishReport(options: PublishOptions): Promise<PublishResult>;
|
|
29
|
+
//# sourceMappingURL=publish.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../src/publish.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAkC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAiB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAEhE,eAAO,MAAM,WAAW,aAAa,CAAC;AAGtC,8FAA8F;AAC9F,eAAO,MAAM,QAAQ,QAAS,CAAC;AAI/B,MAAM,MAAM,aAAa,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtH,yGAAyG;AACzG,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,GAAE,eAAoC,GAAG,MAAM,CAO9H;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,eAAoC,GAAG,MAAM,CAS1H;AAqBD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,qGAAqG;AACrG,wBAAsB,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CA2BnF"}
|
package/dist/publish.js
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
// Keeps one rolling issue per repository up to date with the latest report, and adds a comment per run, so people
|
|
2
|
+
// and agents (with the GitHub tools they already have) read the usage without the artifact.
|
|
3
|
+
import { z } from "zod";
|
|
4
|
+
import { ciUsageMessages, formatMessage } from "./messages/index.js";
|
|
5
|
+
import { REPORT_MARKER } from "./report.js";
|
|
6
|
+
export const ISSUE_LABEL = "ci-usage";
|
|
7
|
+
const LABEL_COLOR = "5319e7";
|
|
8
|
+
const LABEL_DESCRIPTION = "The CI usage report of @softure-ai/ci-usage";
|
|
9
|
+
/** GitHub refuses an issue body above 65,536 characters; a margin keeps the closing lines. */
|
|
10
|
+
export const MAX_BODY = 65_000;
|
|
11
|
+
const ISSUE = z.object({ number: z.number(), body: z.string().nullable().optional(), html_url: z.string(), pull_request: z.unknown().optional() });
|
|
12
|
+
/** The issue body: the Markdown report, then the JSON in a collapsed block when the whole still fits. */
|
|
13
|
+
export function buildIssueBody(markdown, report, messages = ciUsageMessages.en) {
|
|
14
|
+
const head = `${messages.issueIntro}\n\n${markdown.trimEnd()}\n`;
|
|
15
|
+
const json = `\n<details><summary>${messages.jsonSummary}</summary>\n\n\`\`\`json\n${JSON.stringify(report)}\n\`\`\`\n\n</details>\n`;
|
|
16
|
+
if (head.length + json.length <= MAX_BODY)
|
|
17
|
+
return head + json;
|
|
18
|
+
const note = `\n${messages.jsonTooLong}\n`;
|
|
19
|
+
if (head.length + note.length <= MAX_BODY)
|
|
20
|
+
return head + note;
|
|
21
|
+
return `${head.slice(0, MAX_BODY - note.length - 2)}\n…${note}`;
|
|
22
|
+
}
|
|
23
|
+
export function buildComment(report, runUrl, messages = ciUsageMessages.en) {
|
|
24
|
+
return formatMessage(messages.comment, {
|
|
25
|
+
from: report.period.from.slice(0, 16).replace("T", " "),
|
|
26
|
+
to: report.period.to.slice(0, 16).replace("T", " "),
|
|
27
|
+
minutes: report.totals.minutes,
|
|
28
|
+
usd: report.totals.usd === null ? messages.unknown : report.totals.usd.toFixed(2),
|
|
29
|
+
runs: report.totals.runs,
|
|
30
|
+
url: runUrl,
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
async function ensureLabel(client, repository) {
|
|
34
|
+
const found = await client.get(`/repos/${repository}/labels/${ISSUE_LABEL}`);
|
|
35
|
+
if (found.ok)
|
|
36
|
+
return null;
|
|
37
|
+
if (found.kind === "http" && found.status !== 404)
|
|
38
|
+
return found.message;
|
|
39
|
+
const created = await client.send("POST", `/repos/${repository}/labels`, { name: ISSUE_LABEL, color: LABEL_COLOR, description: LABEL_DESCRIPTION });
|
|
40
|
+
// 422: another run created it in the meantime.
|
|
41
|
+
if (!created.ok && !(created.kind === "http" && created.status === 422))
|
|
42
|
+
return created.message;
|
|
43
|
+
return null;
|
|
44
|
+
}
|
|
45
|
+
async function findIssue(client, repository) {
|
|
46
|
+
const listed = await client.get(`/repos/${repository}/issues`, { labels: ISSUE_LABEL, state: "open", per_page: "100" });
|
|
47
|
+
if (!listed.ok)
|
|
48
|
+
return { ok: false, error: listed.message };
|
|
49
|
+
const issues = z.array(ISSUE).safeParse(listed.data);
|
|
50
|
+
if (!issues.success)
|
|
51
|
+
return { ok: false, error: `GET /repos/${repository}/issues answered an unexpected shape` };
|
|
52
|
+
const ours = issues.data.filter((issue) => issue.pull_request === undefined && (issue.body ?? "").includes(REPORT_MARKER)).sort((a, b) => a.number - b.number);
|
|
53
|
+
return { ok: true, number: ours[0]?.number ?? null };
|
|
54
|
+
}
|
|
55
|
+
/** Creates the issue the first time, replaces its body afterwards, and comments the run's totals. */
|
|
56
|
+
export async function publishReport(options) {
|
|
57
|
+
const { client, repository } = options;
|
|
58
|
+
const messages = options.messages ?? ciUsageMessages.en;
|
|
59
|
+
const labelError = await ensureLabel(client, repository);
|
|
60
|
+
if (labelError !== null)
|
|
61
|
+
return { ok: false, error: labelError };
|
|
62
|
+
const found = await findIssue(client, repository);
|
|
63
|
+
if (!found.ok)
|
|
64
|
+
return found;
|
|
65
|
+
const body = buildIssueBody(options.markdown, options.report, messages);
|
|
66
|
+
let number = found.number;
|
|
67
|
+
let url;
|
|
68
|
+
const created = number === null;
|
|
69
|
+
if (number === null) {
|
|
70
|
+
const result = await client.send("POST", `/repos/${repository}/issues`, { title: messages.title, body, labels: [ISSUE_LABEL] });
|
|
71
|
+
if (!result.ok)
|
|
72
|
+
return { ok: false, error: result.message };
|
|
73
|
+
const issue = ISSUE.safeParse(result.data);
|
|
74
|
+
if (!issue.success)
|
|
75
|
+
return { ok: false, error: `POST /repos/${repository}/issues answered an unexpected shape` };
|
|
76
|
+
number = issue.data.number;
|
|
77
|
+
url = issue.data.html_url;
|
|
78
|
+
}
|
|
79
|
+
else {
|
|
80
|
+
const result = await client.send("PATCH", `/repos/${repository}/issues/${String(number)}`, { body });
|
|
81
|
+
if (!result.ok)
|
|
82
|
+
return { ok: false, error: result.message };
|
|
83
|
+
const issue = ISSUE.safeParse(result.data);
|
|
84
|
+
url = issue.success ? issue.data.html_url : `https://github.com/${repository}/issues/${String(number)}`;
|
|
85
|
+
}
|
|
86
|
+
const comment = await client.send("POST", `/repos/${repository}/issues/${String(number)}/comments`, { body: buildComment(options.report, options.runUrl, messages) });
|
|
87
|
+
if (!comment.ok)
|
|
88
|
+
return { ok: false, error: comment.message };
|
|
89
|
+
return { ok: true, issue: number, url, created };
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=publish.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"publish.js","sourceRoot":"","sources":["../src/publish.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAClH,4FAA4F;AAC5F,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,eAAe,EAAE,aAAa,EAAwB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,aAAa,EAAsB,MAAM,aAAa,CAAC;AAEhE,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;AACtC,MAAM,WAAW,GAAG,QAAQ,CAAC;AAC7B,MAAM,iBAAiB,GAAG,6CAA6C,CAAC;AACxE,8FAA8F;AAC9F,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE/B,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAInJ,yGAAyG;AACzG,MAAM,UAAU,cAAc,CAAC,QAAgB,EAAE,MAAqB,EAAE,QAAQ,GAAoB,eAAe,CAAC,EAAE;IACpH,MAAM,IAAI,GAAG,GAAG,QAAQ,CAAC,UAAU,OAAO,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACjE,MAAM,IAAI,GAAG,uBAAuB,QAAQ,CAAC,WAAW,6BAA6B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,0BAA0B,CAAC;IACtI,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,QAAQ;QAAE,OAAO,IAAI,GAAG,IAAI,CAAC;IAC9D,MAAM,IAAI,GAAG,KAAK,QAAQ,CAAC,WAAW,IAAI,CAAC;IAC3C,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,QAAQ;QAAE,OAAO,IAAI,GAAG,IAAI,CAAC;IAC9D,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAqB,EAAE,MAAc,EAAE,QAAQ,GAAoB,eAAe,CAAC,EAAE;IAChH,OAAO,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE;QACrC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;QACvD,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;QACnD,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO;QAC9B,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACjF,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI;QACxB,GAAG,EAAE,MAAM;KACZ,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,MAAoB,EAAE,UAAkB;IACjE,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,UAAU,WAAW,WAAW,EAAE,CAAC,CAAC;IAC7E,IAAI,KAAK,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC;IAC1B,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC;IACxE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,UAAU,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACpJ,+CAA+C;IAC/C,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC;IAChG,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,MAAoB,EAAE,UAAkB;IAC/D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,UAAU,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IACxH,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;IAC5D,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,UAAU,sCAAsC,EAAE,CAAC;IACjH,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/J,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,IAAI,EAAE,CAAC;AACvD,CAAC;AAWD,qGAAqG;AACrG,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAuB;IACzD,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC,EAAE,CAAC;IACxD,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACzD,IAAI,UAAU,KAAK,IAAI;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;IACjE,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClD,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC;IAC5B,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACxE,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC1B,IAAI,GAAW,CAAC;IAChB,MAAM,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC;IAChC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,UAAU,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAChI,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,OAAO;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe,UAAU,sCAAsC,EAAE,CAAC;QACjH,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QAC3B,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,UAAU,WAAW,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACrG,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3C,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,sBAAsB,UAAU,WAAW,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1G,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,UAAU,WAAW,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;IACtK,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;IAC9D,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AACnD,CAAC"}
|
package/dist/report.d.ts
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import type { BilledSku } from "./billing.js";
|
|
2
|
+
import type { CollectResult } from "./collect.js";
|
|
3
|
+
import { type CiUsageMessages } from "./messages/index.js";
|
|
4
|
+
import type { PriceOptions } from "./prices.js";
|
|
5
|
+
import type { Provider } from "./runner.js";
|
|
6
|
+
import { type Cost, type RepositoryUsage } from "./usage.js";
|
|
7
|
+
export declare const SCHEMA_VERSION = 1;
|
|
8
|
+
export declare const REPORT_MARKER = "<!-- softure-ci-usage -->";
|
|
9
|
+
export declare const JSON_FILE = "ci-usage.json";
|
|
10
|
+
export declare const MARKDOWN_FILE = "ci-usage.md";
|
|
11
|
+
export interface RepositoryReport extends RepositoryUsage {
|
|
12
|
+
partial: string[];
|
|
13
|
+
error: string | null;
|
|
14
|
+
runsRunning: number;
|
|
15
|
+
runsFromCache: number;
|
|
16
|
+
/** What GitHub billed, when the billing lookup ran and succeeded; null otherwise. */
|
|
17
|
+
billing: BilledSku[] | null;
|
|
18
|
+
}
|
|
19
|
+
export interface CiUsageReport {
|
|
20
|
+
schemaVersion: typeof SCHEMA_VERSION;
|
|
21
|
+
generatedAt: string;
|
|
22
|
+
period: {
|
|
23
|
+
from: string;
|
|
24
|
+
to: string;
|
|
25
|
+
days: number;
|
|
26
|
+
};
|
|
27
|
+
partial: boolean;
|
|
28
|
+
totals: Cost & {
|
|
29
|
+
runs: number;
|
|
30
|
+
jobs: number;
|
|
31
|
+
byProvider: Record<Provider, Cost>;
|
|
32
|
+
};
|
|
33
|
+
prices: {
|
|
34
|
+
source: string;
|
|
35
|
+
checkedOn: string;
|
|
36
|
+
ubicloudPremium: boolean;
|
|
37
|
+
labels: Record<string, number>;
|
|
38
|
+
};
|
|
39
|
+
/** Report-wide notes, such as a refused billing lookup. */
|
|
40
|
+
notes: string[];
|
|
41
|
+
repositories: RepositoryReport[];
|
|
42
|
+
}
|
|
43
|
+
export interface BuildReportOptions {
|
|
44
|
+
collected: readonly CollectResult[];
|
|
45
|
+
from: Date;
|
|
46
|
+
to: Date;
|
|
47
|
+
generatedAt: Date;
|
|
48
|
+
priceOptions: PriceOptions;
|
|
49
|
+
billing?: {
|
|
50
|
+
byRepository: Record<string, BilledSku[]>;
|
|
51
|
+
} | {
|
|
52
|
+
error: string;
|
|
53
|
+
} | null;
|
|
54
|
+
}
|
|
55
|
+
export declare function buildReport(options: BuildReportOptions): CiUsageReport;
|
|
56
|
+
export declare function renderMarkdown(report: CiUsageReport, messages?: CiUsageMessages): string;
|
|
57
|
+
//# sourceMappingURL=report.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAkC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7E,eAAO,MAAM,cAAc,IAAI,CAAC;AAChC,eAAO,MAAM,aAAa,8BAA8B,CAAC;AACzD,eAAO,MAAM,SAAS,kBAAkB,CAAC;AACzC,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAG3C,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,OAAO,cAAc,CAAC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;KAAE,CAAC;IAClF,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IACxG,2DAA2D;IAC3D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,YAAY,EAAE,gBAAgB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,SAAS,aAAa,EAAE,CAAC;IACpC,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,IAAI,CAAC;IACT,WAAW,EAAE,IAAI,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,CAAC,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACpF;AAgBD,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,aAAa,CAoCtE;AA4ED,wBAAgB,cAAc,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,GAAE,eAAoC,GAAG,MAAM,CA4C5G"}
|
package/dist/report.js
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import { ciUsageMessages, formatMessage } from "./messages/index.js";
|
|
2
|
+
import { summarizeUsage } from "./usage.js";
|
|
3
|
+
export const SCHEMA_VERSION = 1;
|
|
4
|
+
export const REPORT_MARKER = "<!-- softure-ci-usage -->";
|
|
5
|
+
export const JSON_FILE = "ci-usage.json";
|
|
6
|
+
export const MARKDOWN_FILE = "ci-usage.md";
|
|
7
|
+
const TOP_JOBS = 15;
|
|
8
|
+
function emptyCost() {
|
|
9
|
+
return { minutes: 0, usd: 0, unpricedMinutes: 0 };
|
|
10
|
+
}
|
|
11
|
+
function addTo(total, cost) {
|
|
12
|
+
total.minutes += cost.minutes;
|
|
13
|
+
total.unpricedMinutes += cost.unpricedMinutes;
|
|
14
|
+
if (cost.usd === null) {
|
|
15
|
+
if (cost.minutes > 0)
|
|
16
|
+
total.usd = null;
|
|
17
|
+
}
|
|
18
|
+
else if (total.usd !== null) {
|
|
19
|
+
total.usd = Math.round((total.usd + cost.usd) * 10_000) / 10_000;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
export function buildReport(options) {
|
|
23
|
+
const billing = options.billing ?? null;
|
|
24
|
+
const byRepository = billing !== null && "byRepository" in billing ? billing.byRepository : null;
|
|
25
|
+
const repositories = options.collected.map((result) => ({
|
|
26
|
+
...summarizeUsage(result.repository, result.jobs, options.priceOptions),
|
|
27
|
+
partial: result.partial,
|
|
28
|
+
error: result.error,
|
|
29
|
+
runsRunning: result.runs.running,
|
|
30
|
+
runsFromCache: result.runs.fromCache,
|
|
31
|
+
billing: byRepository?.[result.repository] ?? null,
|
|
32
|
+
}));
|
|
33
|
+
const byProvider = { "github-hosted": emptyCost(), ubicloud: emptyCost(), "self-hosted": emptyCost() };
|
|
34
|
+
const totals = { ...emptyCost(), runs: 0, jobs: 0, byProvider };
|
|
35
|
+
for (const repository of repositories) {
|
|
36
|
+
addTo(totals, repository);
|
|
37
|
+
totals.runs += repository.runs;
|
|
38
|
+
totals.jobs += repository.jobs;
|
|
39
|
+
for (const provider of Object.keys(byProvider))
|
|
40
|
+
addTo(byProvider[provider], repository.byProvider[provider]);
|
|
41
|
+
}
|
|
42
|
+
const notes = billing !== null && "error" in billing ? [billing.error] : [];
|
|
43
|
+
const days = Math.round(((options.to.getTime() - options.from.getTime()) / 86_400_000) * 100) / 100;
|
|
44
|
+
return {
|
|
45
|
+
schemaVersion: SCHEMA_VERSION,
|
|
46
|
+
generatedAt: options.generatedAt.toISOString(),
|
|
47
|
+
period: { from: options.from.toISOString(), to: options.to.toISOString(), days },
|
|
48
|
+
partial: notes.length > 0 || repositories.some((repository) => repository.partial.length > 0 || repository.error !== null),
|
|
49
|
+
totals,
|
|
50
|
+
prices: {
|
|
51
|
+
source: options.priceOptions.prices.source,
|
|
52
|
+
checkedOn: options.priceOptions.prices.checkedOn,
|
|
53
|
+
ubicloudPremium: options.priceOptions.ubicloudPremium,
|
|
54
|
+
labels: options.priceOptions.prices.labels,
|
|
55
|
+
},
|
|
56
|
+
notes,
|
|
57
|
+
repositories,
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
function formatTime(iso) {
|
|
61
|
+
return iso.replace(/:\d{2}\.\d{3}Z$/, "").replace("T", " ");
|
|
62
|
+
}
|
|
63
|
+
function formatUsd(usd, messages) {
|
|
64
|
+
return usd === null ? messages.unknown : usd.toFixed(2);
|
|
65
|
+
}
|
|
66
|
+
function formatShare(share) {
|
|
67
|
+
return `${(share * 100).toFixed(1)}%`;
|
|
68
|
+
}
|
|
69
|
+
/** A Markdown table cell: backslashes, pipes and line breaks would break the row. */
|
|
70
|
+
function cell(text) {
|
|
71
|
+
return text.replace(/\\/g, "\\\\").replace(/\|/g, "\\|").replace(/[\r\n]+/g, " ");
|
|
72
|
+
}
|
|
73
|
+
function table(header, rows) {
|
|
74
|
+
return [`| ${header.join(" | ")} |`, `| ${header.map(() => "---").join(" | ")} |`, ...rows.map((row) => `| ${row.map(cell).join(" | ")} |`), ""];
|
|
75
|
+
}
|
|
76
|
+
function renderRepository(repository, messages) {
|
|
77
|
+
const lines = [`## ${repository.repository}`, ""];
|
|
78
|
+
if (repository.error !== null)
|
|
79
|
+
return [...lines, formatMessage(messages.error, { error: repository.error }), ""];
|
|
80
|
+
if (repository.runs === 0)
|
|
81
|
+
lines.push(messages.noRuns, "");
|
|
82
|
+
if (repository.byWorkflow.length > 0) {
|
|
83
|
+
lines.push(`### ${messages.workflowsHeading}`, "");
|
|
84
|
+
lines.push(...table([messages.workflow, messages.runs, messages.jobs, messages.minutes, messages.share, messages.usd], repository.byWorkflow.map((workflow) => [
|
|
85
|
+
`${workflow.name} (\`${workflow.path}\`)`,
|
|
86
|
+
String(workflow.runs),
|
|
87
|
+
String(workflow.jobs),
|
|
88
|
+
String(workflow.minutes),
|
|
89
|
+
formatShare(workflow.share),
|
|
90
|
+
formatUsd(workflow.usd, messages),
|
|
91
|
+
])));
|
|
92
|
+
const jobs = repository.byWorkflow
|
|
93
|
+
.flatMap((workflow) => workflow.byJob.map((job) => ({ workflow: workflow.name, ...job })))
|
|
94
|
+
.sort((a, b) => b.minutes - a.minutes)
|
|
95
|
+
.slice(0, TOP_JOBS)
|
|
96
|
+
.filter((job) => job.minutes > 0);
|
|
97
|
+
if (jobs.length > 0) {
|
|
98
|
+
lines.push(`### ${messages.topJobsHeading}`, "");
|
|
99
|
+
lines.push(...table([messages.workflow, messages.job, messages.runner, messages.count, messages.minutes, messages.p50, messages.p95, messages.usd], jobs.map((job) => [job.workflow, job.name, `\`${job.runner}\``, String(job.count), String(job.minutes), String(job.p50Minutes), String(job.p95Minutes), formatUsd(job.usd, messages)])));
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
if (repository.longestJobs.length > 0) {
|
|
103
|
+
lines.push(`### ${messages.longestHeading}`, "");
|
|
104
|
+
for (const job of repository.longestJobs) {
|
|
105
|
+
lines.push(`- ${formatMessage(messages.longestItem, { minutes: job.minutes, url: job.url, workflow: job.workflow, job: job.job, runner: job.runner })}`);
|
|
106
|
+
}
|
|
107
|
+
lines.push("");
|
|
108
|
+
}
|
|
109
|
+
if (repository.billing !== null && repository.billing.length > 0) {
|
|
110
|
+
lines.push(`### ${messages.billingHeading}`, "");
|
|
111
|
+
lines.push(...table([messages.sku, messages.minutes, messages.gross, messages.net], repository.billing.map((sku) => [sku.sku, String(sku.minutes), sku.grossUsd.toFixed(2), sku.netUsd.toFixed(2)])));
|
|
112
|
+
}
|
|
113
|
+
const notes = [...repository.partial];
|
|
114
|
+
if (repository.runsRunning > 0)
|
|
115
|
+
notes.push(formatMessage(messages.running, { count: repository.runsRunning }));
|
|
116
|
+
if (repository.runsFromCache > 0)
|
|
117
|
+
notes.push(formatMessage(messages.fromCache, { count: repository.runsFromCache, total: repository.runs }));
|
|
118
|
+
if (repository.unpricedMinutes > 0)
|
|
119
|
+
notes.push(formatMessage(messages.unknownPrice, { minutes: repository.unpricedMinutes }));
|
|
120
|
+
if (notes.length > 0)
|
|
121
|
+
lines.push(`### ${messages.notesHeading}`, "", ...notes.map((note) => `- ${note}`), "");
|
|
122
|
+
return lines;
|
|
123
|
+
}
|
|
124
|
+
export function renderMarkdown(report, messages = ciUsageMessages.en) {
|
|
125
|
+
const lines = [
|
|
126
|
+
REPORT_MARKER,
|
|
127
|
+
`# ${messages.title}`,
|
|
128
|
+
"",
|
|
129
|
+
formatMessage(messages.period, { from: formatTime(report.period.from), to: formatTime(report.period.to), days: report.period.days, generated: formatTime(report.generatedAt) }),
|
|
130
|
+
report.partial ? messages.partial : messages.complete,
|
|
131
|
+
"",
|
|
132
|
+
messages.howToRead,
|
|
133
|
+
"",
|
|
134
|
+
`## ${messages.totalsHeading}`,
|
|
135
|
+
"",
|
|
136
|
+
...table([messages.repository, messages.minutes, messages.usd, messages.githubHosted, messages.ubicloud, messages.selfHosted, messages.runs], [
|
|
137
|
+
...report.repositories.map((repository) => [
|
|
138
|
+
repository.repository,
|
|
139
|
+
repository.error === null ? String(repository.minutes) : "—",
|
|
140
|
+
repository.error === null ? formatUsd(repository.usd, messages) : "—",
|
|
141
|
+
String(repository.byProvider["github-hosted"].minutes),
|
|
142
|
+
String(repository.byProvider.ubicloud.minutes),
|
|
143
|
+
String(repository.byProvider["self-hosted"].minutes),
|
|
144
|
+
String(repository.runs),
|
|
145
|
+
]),
|
|
146
|
+
...(report.repositories.length > 1
|
|
147
|
+
? [
|
|
148
|
+
[
|
|
149
|
+
`**${messages.totalsHeading}**`,
|
|
150
|
+
String(report.totals.minutes),
|
|
151
|
+
formatUsd(report.totals.usd, messages),
|
|
152
|
+
String(report.totals.byProvider["github-hosted"].minutes),
|
|
153
|
+
String(report.totals.byProvider.ubicloud.minutes),
|
|
154
|
+
String(report.totals.byProvider["self-hosted"].minutes),
|
|
155
|
+
String(report.totals.runs),
|
|
156
|
+
],
|
|
157
|
+
]
|
|
158
|
+
: []),
|
|
159
|
+
]),
|
|
160
|
+
];
|
|
161
|
+
if (report.notes.length > 0)
|
|
162
|
+
lines.push(...report.notes.map((note) => `- ${note}`), "");
|
|
163
|
+
for (const repository of report.repositories)
|
|
164
|
+
lines.push(...renderRepository(repository, messages));
|
|
165
|
+
lines.push(formatMessage(messages.prices, { source: report.prices.source, checkedOn: report.prices.checkedOn, premium: report.prices.ubicloudPremium ? messages.premium : "" }), "");
|
|
166
|
+
return lines.join("\n");
|
|
167
|
+
}
|
|
168
|
+
//# sourceMappingURL=report.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"report.js","sourceRoot":"","sources":["../src/report.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAwB,MAAM,qBAAqB,CAAC;AAG3F,OAAO,EAAE,cAAc,EAAmC,MAAM,YAAY,CAAC;AAE7E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAChC,MAAM,CAAC,MAAM,aAAa,GAAG,2BAA2B,CAAC;AACzD,MAAM,CAAC,MAAM,SAAS,GAAG,eAAe,CAAC;AACzC,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAAC;AAC3C,MAAM,QAAQ,GAAG,EAAE,CAAC;AAgCpB,SAAS,SAAS;IAChB,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,CAAC;AACpD,CAAC;AAED,SAAS,KAAK,CAAC,KAAW,EAAE,IAAU;IACpC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;IAC9B,KAAK,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC;IAC9C,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;QACtB,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC;YAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC;IACzC,CAAC;SAAM,IAAI,KAAK,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;QAC9B,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC;IACnE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAA2B;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC;IACxC,MAAM,YAAY,GAAG,OAAO,KAAK,IAAI,IAAI,cAAc,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC;IACjG,MAAM,YAAY,GAAuB,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC1E,GAAG,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC;QACvE,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO;QAChC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS;QACpC,OAAO,EAAE,YAAY,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI;KACnD,CAAC,CAAC,CAAC;IACJ,MAAM,UAAU,GAA2B,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAAC;IAC/H,MAAM,MAAM,GAAG,EAAE,GAAG,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;IAChE,KAAK,MAAM,UAAU,IAAI,YAAY,EAAE,CAAC;QACtC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC1B,MAAM,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC;QAC/B,MAAM,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC;QAC/B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAe;YAAE,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7H,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,KAAK,IAAI,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;IACpG,OAAO;QACL,aAAa,EAAE,cAAc;QAC7B,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;QAC9C,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE;QAChF,OAAO,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,KAAK,KAAK,IAAI,CAAC;QAC1H,MAAM;QACN,MAAM,EAAE;YACN,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM;YAC1C,SAAS,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS;YAChD,eAAe,EAAE,OAAO,CAAC,YAAY,CAAC,eAAe;YACrD,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM;SAC3C;QACD,KAAK;QACL,YAAY;KACb,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,SAAS,CAAC,GAAkB,EAAE,QAAyB;IAC9D,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC;AACxC,CAAC;AAED,qFAAqF;AACrF,SAAS,IAAI,CAAC,IAAY;IACxB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AACpF,CAAC;AAED,SAAS,KAAK,CAAC,MAAgB,EAAE,IAAgB;IAC/C,OAAO,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;AACnJ,CAAC;AAED,SAAS,gBAAgB,CAAC,UAA4B,EAAE,QAAyB;IAC/E,MAAM,KAAK,GAAG,CAAC,MAAM,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IAClD,IAAI,UAAU,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,CAAC,GAAG,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACjH,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3D,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrC,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,gBAAgB,EAAE,EAAE,EAAE,CAAC,CAAC;QACnD,KAAK,CAAC,IAAI,CACR,GAAG,KAAK,CACN,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EACjG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtC,GAAG,QAAQ,CAAC,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK;YACzC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACrB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACrB,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;YACxB,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC3B,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;SAClC,CAAC,CACH,CACF,CAAC;QACF,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU;aAC/B,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;aACzF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;aACrC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC;aAClB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,cAAc,EAAE,EAAE,EAAE,CAAC,CAAC;YACjD,KAAK,CAAC,IAAI,CACR,GAAG,KAAK,CACN,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,EAC9H,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CACvL,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,cAAc,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,KAAK,aAAa,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;QAC3J,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjE,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,cAAc,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxM,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,UAAU,CAAC,WAAW,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC/G,IAAI,UAAU,CAAC,aAAa,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC7I,IAAI,UAAU,CAAC,eAAe,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;IAC9H,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9G,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,MAAqB,EAAE,QAAQ,GAAoB,eAAe,CAAC,EAAE;IAClG,MAAM,KAAK,GAAG;QACZ,aAAa;QACb,KAAK,QAAQ,CAAC,KAAK,EAAE;QACrB,EAAE;QACF,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/K,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ;QACrD,EAAE;QACF,QAAQ,CAAC,SAAS;QAClB,EAAE;QACF,MAAM,QAAQ,CAAC,aAAa,EAAE;QAC9B,EAAE;QACF,GAAG,KAAK,CACN,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,EACnI;YACE,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC;gBACzC,UAAU,CAAC,UAAU;gBACrB,UAAU,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG;gBAC5D,UAAU,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG;gBACrE,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC;gBACtD,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAC9C,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;gBACpD,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC;aACxB,CAAC;YACF,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC;gBAChC,CAAC,CAAC;oBACE;wBACE,KAAK,QAAQ,CAAC,aAAa,IAAI;wBAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;wBAC7B,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC;wBACtC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC;wBACzD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC;wBACjD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC;wBACvD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;qBAC3B;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CACF;KACF,CAAC;IACF,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACxF,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,YAAY;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACrL,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}
|
package/dist/runner.d.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/** GitHub's billing SKUs for its standard hosted runners ("Actions runner pricing"). */
|
|
2
|
+
export declare const GITHUB_SKUS: readonly ["actions_linux_slim", "actions_linux", "actions_linux_arm", "actions_windows", "actions_windows_arm", "actions_macos"];
|
|
3
|
+
export type GithubSku = (typeof GITHUB_SKUS)[number];
|
|
4
|
+
export type Architecture = "x64" | "arm64";
|
|
5
|
+
export type RunnerClass = {
|
|
6
|
+
provider: "github-hosted";
|
|
7
|
+
label: string;
|
|
8
|
+
sku: GithubSku;
|
|
9
|
+
} | {
|
|
10
|
+
provider: "ubicloud";
|
|
11
|
+
label: string;
|
|
12
|
+
vcpu: number;
|
|
13
|
+
architecture: Architecture;
|
|
14
|
+
} | {
|
|
15
|
+
provider: "self-hosted";
|
|
16
|
+
label: string;
|
|
17
|
+
};
|
|
18
|
+
export type Provider = RunnerClass["provider"];
|
|
19
|
+
export interface RunnerInput {
|
|
20
|
+
labels: readonly string[];
|
|
21
|
+
runnerGroupName: string | null;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Classifies one job's runner. A Ubicloud label wins; then a GitHub image label (`ubuntu-*`, `windows-*`, `macos-*`)
|
|
25
|
+
* or GitHub's own runner group; anything else is a self-hosted runner priced only from the caller's table.
|
|
26
|
+
*/
|
|
27
|
+
export declare function classifyRunner(input: RunnerInput): RunnerClass;
|
|
28
|
+
//# sourceMappingURL=runner.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAEA,wFAAwF;AACxF,eAAO,MAAM,WAAW,YAAI,oBAAoB,EAAE,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,eAAe,CAAU,CAAC;AAE5J,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,OAAO,CAAC;AAE3C,MAAM,MAAM,WAAW,GACnB;IAAE,QAAQ,EAAE,eAAe,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,SAAS,CAAA;CAAE,GAC5D;IAAE,QAAQ,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,YAAY,CAAA;CAAE,GACjF;IAAE,QAAQ,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/C,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;AAE/C,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AA0BD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW,CAc9D"}
|
package/dist/runner.js
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
// Which runner a job ran on, read from the labels it asked for and the runner group that took it.
|
|
2
|
+
/** GitHub's billing SKUs for its standard hosted runners ("Actions runner pricing"). */
|
|
3
|
+
export const GITHUB_SKUS = ["actions_linux_slim", "actions_linux", "actions_linux_arm", "actions_windows", "actions_windows_arm", "actions_macos"];
|
|
4
|
+
/** The runner group GitHub assigns to its own hosted runners. */
|
|
5
|
+
const GITHUB_RUNNER_GROUP = "GitHub Actions";
|
|
6
|
+
const UBICLOUD_LABEL = /^ubicloud(?:-(?:standard|premium)-(\d+))?(-arm)?(?:-ubuntu-\d{4})?$/;
|
|
7
|
+
const UBICLOUD_VCPUS = new Set([2, 4, 8, 16, 30]);
|
|
8
|
+
const DEFAULT_UBICLOUD_VCPU = 2;
|
|
9
|
+
function getGithubSku(label) {
|
|
10
|
+
if (label === "ubuntu-slim")
|
|
11
|
+
return "actions_linux_slim";
|
|
12
|
+
if (/^ubuntu-.*-arm$/.test(label))
|
|
13
|
+
return "actions_linux_arm";
|
|
14
|
+
if (label.startsWith("ubuntu-"))
|
|
15
|
+
return "actions_linux";
|
|
16
|
+
if (/^windows-.*-arm$/.test(label))
|
|
17
|
+
return "actions_windows_arm";
|
|
18
|
+
if (label.startsWith("windows-"))
|
|
19
|
+
return "actions_windows";
|
|
20
|
+
if (label.startsWith("macos-"))
|
|
21
|
+
return "actions_macos";
|
|
22
|
+
return null;
|
|
23
|
+
}
|
|
24
|
+
function classifyUbicloud(label) {
|
|
25
|
+
const match = UBICLOUD_LABEL.exec(label);
|
|
26
|
+
if (!match)
|
|
27
|
+
return null;
|
|
28
|
+
const vcpu = match[1] === undefined ? DEFAULT_UBICLOUD_VCPU : Number(match[1]);
|
|
29
|
+
if (!UBICLOUD_VCPUS.has(vcpu))
|
|
30
|
+
return null;
|
|
31
|
+
return { provider: "ubicloud", label, vcpu, architecture: match[2] === undefined ? "x64" : "arm64" };
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Classifies one job's runner. A Ubicloud label wins; then a GitHub image label (`ubuntu-*`, `windows-*`, `macos-*`)
|
|
35
|
+
* or GitHub's own runner group; anything else is a self-hosted runner priced only from the caller's table.
|
|
36
|
+
*/
|
|
37
|
+
export function classifyRunner(input) {
|
|
38
|
+
const label = input.labels.join(",") || "unknown";
|
|
39
|
+
for (const candidate of input.labels) {
|
|
40
|
+
const ubicloud = classifyUbicloud(candidate);
|
|
41
|
+
if (ubicloud)
|
|
42
|
+
return ubicloud;
|
|
43
|
+
}
|
|
44
|
+
for (const candidate of input.labels) {
|
|
45
|
+
const sku = getGithubSku(candidate);
|
|
46
|
+
if (sku)
|
|
47
|
+
return { provider: "github-hosted", label: candidate, sku };
|
|
48
|
+
}
|
|
49
|
+
// A larger GitHub runner carries a custom label but runs in GitHub's group; it is billed like Linux unless the
|
|
50
|
+
// caller's price table names its label.
|
|
51
|
+
if (input.runnerGroupName === GITHUB_RUNNER_GROUP)
|
|
52
|
+
return { provider: "github-hosted", label, sku: "actions_linux" };
|
|
53
|
+
return { provider: "self-hosted", label };
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=runner.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runner.js","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAElG,wFAAwF;AACxF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,oBAAoB,EAAE,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,eAAe,CAAU,CAAC;AAkB5J,iEAAiE;AACjE,MAAM,mBAAmB,GAAG,gBAAgB,CAAC;AAC7C,MAAM,cAAc,GAAG,qEAAqE,CAAC;AAC7F,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;AAClD,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAEhC,SAAS,YAAY,CAAC,KAAa;IACjC,IAAI,KAAK,KAAK,aAAa;QAAE,OAAO,oBAAoB,CAAC;IACzD,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,mBAAmB,CAAC;IAC9D,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC;QAAE,OAAO,eAAe,CAAC;IACxD,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,qBAAqB,CAAC;IACjE,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC;QAAE,OAAO,iBAAiB,CAAC;IAC3D,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,eAAe,CAAC;IACvD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAa;IACrC,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/E,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3C,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;AACvG,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,KAAkB;IAC/C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC;IAClD,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;IAChC,CAAC;IACD,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,GAAG;YAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;IACvE,CAAC;IACD,+GAA+G;IAC/G,wCAAwC;IACxC,IAAI,KAAK,CAAC,eAAe,KAAK,mBAAmB;QAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC;IACrH,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;AAC5C,CAAC"}
|