@intentius/chant 0.124.103 → 0.124.105
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/dist/audit/secrets.d.ts +6 -0
- package/dist/audit/secrets.js +9 -2
- package/dist/capabilities/templates.d.ts +66 -3
- package/dist/capabilities/templates.js +220 -81
- package/dist/cli/commands/import-index.d.ts +15 -0
- package/dist/cli/commands/import-index.js +37 -3
- package/dist/cli/handlers/lifecycle.js +6 -0
- package/dist/cli/handlers/release-config.d.ts +15 -0
- package/dist/cli/handlers/release-config.js +58 -0
- package/dist/cli/handlers/release-doctor.js +8 -3
- package/dist/cli/handlers/release-init.js +7 -4
- package/dist/cli/handlers/release.js +36 -3
- package/dist/cli/handlers/search.d.ts +1 -1
- package/dist/cli/handlers/search.js +24 -2
- package/dist/cli/main.js +12 -2
- package/dist/cli/parse-args.js +9 -2
- package/dist/cli/registry.d.ts +2 -0
- package/dist/cli/release-commands/cut.js +3 -0
- package/dist/cli/release-commands/doctor.js +5 -2
- package/dist/cloud-lister/aws.d.ts +9 -0
- package/dist/cloud-lister/aws.js +20 -0
- package/dist/config-import.js +26 -4
- package/dist/config.d.ts +24 -0
- package/dist/config.js +6 -0
- package/dist/floor-table.data.js +8 -6
- package/dist/floor-table.js +3 -1
- package/dist/graph-refs.d.ts +22 -0
- package/dist/graph-refs.js +20 -11
- package/dist/lifecycle/cloud-index.d.ts +6 -0
- package/dist/lifecycle/cloud-index.js +32 -5
- package/dist/lifecycle/derive-edges.d.ts +1 -1
- package/dist/lifecycle/derive-edges.js +5 -3
- package/dist/lifecycle/identity-match.d.ts +18 -2
- package/dist/lifecycle/identity-match.js +10 -5
- package/dist/lifecycle/index-drift.d.ts +13 -0
- package/dist/lifecycle/index-drift.js +21 -3
- package/dist/lifecycle/index-import.d.ts +24 -2
- package/dist/lifecycle/index-import.js +61 -9
- package/dist/lifecycle/index-join.d.ts +1 -1
- package/dist/lifecycle/index-join.js +1 -1
- package/dist/lifecycle/publish-declaration.d.ts +6 -0
- package/dist/lifecycle/publish-declaration.js +18 -1
- package/dist/lifecycle/publish-forge.d.ts +2 -0
- package/dist/lifecycle/publish-forge.js +3 -1
- package/dist/lifecycle/publish-oci.d.ts +27 -0
- package/dist/lifecycle/publish-oci.js +63 -8
- package/dist/lifecycle/release-artifacts.js +3 -1
- package/dist/lifecycle/release-at.d.ts +5 -1
- package/dist/lifecycle/release-at.js +69 -4
- package/dist/lifecycle/release-changelog.d.ts +18 -5
- package/dist/lifecycle/release-changelog.js +22 -10
- package/dist/lifecycle/release-cut.d.ts +13 -1
- package/dist/lifecycle/release-cut.js +3 -0
- package/dist/lifecycle/release-doctor.d.ts +10 -0
- package/dist/lifecycle/release-doctor.js +84 -14
- package/dist/lifecycle/release-green.d.ts +5 -2
- package/dist/lifecycle/release-green.js +40 -8
- package/dist/lifecycle/release-images.d.ts +39 -3
- package/dist/lifecycle/release-images.js +84 -7
- package/dist/lifecycle/release-init-goreleaser-images.d.ts +21 -0
- package/dist/lifecycle/release-init-goreleaser-images.js +160 -0
- package/dist/lifecycle/release-init.d.ts +38 -7
- package/dist/lifecycle/release-init.js +298 -52
- package/dist/lifecycle/release-next.d.ts +1 -1
- package/dist/lifecycle/release-next.js +9 -4
- package/dist/local-chant.d.ts +3 -0
- package/dist/local-chant.js +28 -2
- package/dist/release-floors.d.ts +10 -6
- package/dist/release-floors.js +10 -6
- package/dist/ts-loader.d.ts +12 -3
- package/dist/ts-loader.js +27 -11
- package/dist/wave-runtime.mjs +292 -291
- package/dist/workspace/capabilities-contract.d.ts +15 -5
- package/dist/workspace/capabilities-contract.js +7 -4
- package/dist/workspace/capabilities.schema.json +45 -1
- package/dist/workspace/catalog-edges.d.ts +22 -0
- package/dist/workspace/catalog-edges.js +23 -0
- package/dist/workspace/release-changed.d.ts +2 -0
- package/dist/workspace/release-changed.js +7 -2
- package/dist/workspace/release-steps/doctor.js +2 -1
- package/dist/workspace/release-steps/goreleaser.d.ts +6 -3
- package/dist/workspace/release-steps/goreleaser.js +12 -6
- package/dist/workspace/release-toolchains.d.ts +6 -0
- package/dist/workspace/release-toolchains.js +8 -0
- package/dist/workspace/release-train-workflow.d.ts +18 -0
- package/dist/workspace/release-train-workflow.js +135 -7
- package/dist/workspace/release-train.js +1 -1
- package/dist/workspace/release-workflow.d.ts +26 -0
- package/dist/workspace/release-workflow.js +60 -12
- package/dist/workspace/train-artifacts.js +3 -4
- package/dist/workspace/train-cut.d.ts +22 -1
- package/dist/workspace/train-cut.js +80 -16
- package/package.json +2 -2
|
@@ -35,6 +35,7 @@
|
|
|
35
35
|
import { execFileSync, spawn } from "node:child_process";
|
|
36
36
|
import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
|
|
37
37
|
import { isAbsolute, join, resolve } from "node:path";
|
|
38
|
+
import { parseYAML } from "../yaml.js";
|
|
38
39
|
import { createRedactor, readCredential } from "./publish-credentials.js";
|
|
39
40
|
/** The first chant with `chant release doctor`, which checks each `release.publish` target before a cut, and whose `chant release workflow` runs it in a dispatched release's cut job (`release.workflow.doctor`) (#5161). */
|
|
40
41
|
export const RELEASE_DOCTOR_FLOOR = "0.124.101";
|
|
@@ -58,7 +59,7 @@ export function doctorEnvironment(env, req) {
|
|
|
58
59
|
const ref = env.GITHUB_WORKFLOW_REF ?? "";
|
|
59
60
|
const repository = env.GITHUB_REPOSITORY ?? (ci === "gitlab" ? (env.CI_PROJECT_PATH ?? null) : originRepository(req.cwd));
|
|
60
61
|
const workflow = ci === "github" && repository && ref.startsWith(`${repository}/`) ? ref.slice(repository.length + 1).replace(/@.*$/, "") : null;
|
|
61
|
-
return { ci, oidc, workflow, repository, releaseWorkflow: req.releaseWorkflow };
|
|
62
|
+
return { ci, oidc, workflow, repository, releaseWorkflow: req.releaseWorkflow, ...(req.from ? { from: req.from } : {}) };
|
|
62
63
|
}
|
|
63
64
|
/** `owner/name` of the `origin` remote, or null. */
|
|
64
65
|
function originRepository(cwd) {
|
|
@@ -75,7 +76,7 @@ function originRepository(cwd) {
|
|
|
75
76
|
export async function releaseDoctor(req) {
|
|
76
77
|
const env = req.env ?? process.env;
|
|
77
78
|
const deps = req.deps ?? {};
|
|
78
|
-
const environment = doctorEnvironment(env, { cwd: req.cwd, releaseWorkflow: req.releaseWorkflow });
|
|
79
|
+
const environment = doctorEnvironment(env, { cwd: req.cwd, releaseWorkflow: req.releaseWorkflow, ...(req.from ? { from: req.from } : {}) });
|
|
79
80
|
const redactor = createRedactor(env);
|
|
80
81
|
const ctx = {
|
|
81
82
|
cwd: req.cwd,
|
|
@@ -214,6 +215,23 @@ function missing(ctx, check, what, fix) {
|
|
|
214
215
|
? { check, status: "fail", message: `${what}, so a publish from this job fails`, fix }
|
|
215
216
|
: { check, status: "warn", message: `${what} in this shell; the release job needs it in its environment`, fix };
|
|
216
217
|
}
|
|
218
|
+
/**
|
|
219
|
+
* An OIDC token this job lacks, where the job is the cut job (`--from cut`):
|
|
220
|
+
* the release workflow gives the publish job the token and keeps it from the
|
|
221
|
+
* cut, which runs the project's build. The check can't tell from here.
|
|
222
|
+
*/
|
|
223
|
+
function deferredToPublish(ctx, check, what) {
|
|
224
|
+
const held = ctx.environment.ci === "gitlab" ? "the publish job's id_tokens" : "the publish job's id-token: write";
|
|
225
|
+
return { check, status: "unknown", message: `${what}; this is the cut job, which runs without OIDC, and ${held} is what a publish uses, so only a run of the publish job can test this` };
|
|
226
|
+
}
|
|
227
|
+
/** No OIDC ID token for a trusted-publishing check: a failure, except in the cut job, where it can't be told. */
|
|
228
|
+
function noIdToken(ctx, check, none, fix, failMessage = none) {
|
|
229
|
+
return ctx.environment.from === "cut" ? deferredToPublish(ctx, check, none) : { check, status: "fail", message: failMessage, fix };
|
|
230
|
+
}
|
|
231
|
+
/** A token the publish needs, unset here. Where the target could use OIDC instead and this is the cut job, the publish job may hold that. */
|
|
232
|
+
function tokenMissing(ctx, check, what, fix, oidcCapable) {
|
|
233
|
+
return oidcCapable && ctx.environment.from === "cut" ? deferredToPublish(ctx, check, what) : missing(ctx, check, what, fix);
|
|
234
|
+
}
|
|
217
235
|
async function answer(ctx, url, init) {
|
|
218
236
|
const res = await ctx.fetch(url, { ...init, headers: { "user-agent": "chant", ...init.headers } });
|
|
219
237
|
const text = await res.text().catch(() => "");
|
|
@@ -376,7 +394,7 @@ async function checkNpm(decl, ctx) {
|
|
|
376
394
|
else if (exists) {
|
|
377
395
|
const id = await idToken(ctx, `npm:${host}`, "NPM_ID_TOKEN");
|
|
378
396
|
if ("none" in id) {
|
|
379
|
-
checks.push(user ? { check: "npm-trusted-publisher", status: "unknown", message: `no trusted-publisher exchange: ${id.none}. npm's config signs in as ${user}, which the publish uses instead` } :
|
|
397
|
+
checks.push(user ? { check: "npm-trusted-publisher", status: "unknown", message: `no trusted-publisher exchange: ${id.none}. npm's config signs in as ${user}, which the publish uses instead` } : noIdToken(ctx, "npm-trusted-publisher", `${id.none}, and npm's config has no token`, "Give the job permissions: id-token: write (GitLab: an NPM_ID_TOKEN under id_tokens), or a token in the npm config it reads.", `${id.none}, and npm's config has no token, so nothing here can publish ${name}`));
|
|
380
398
|
}
|
|
381
399
|
else {
|
|
382
400
|
const ex = await answer(ctx, `${registry}/-/npm/v1/oidc/token/exchange/package/${name.replace("/", "%2f")}`, { method: "POST", headers: { authorization: `Bearer ${id.token}` } });
|
|
@@ -414,7 +432,7 @@ async function checkNpm(decl, ctx) {
|
|
|
414
432
|
: { check: "npm-token", status: "unknown", message: `npm's config signs in as ${user}; ${registry} did not say what ${user} may do to ${name}, and a granular token's own scope is not shown` });
|
|
415
433
|
}
|
|
416
434
|
else if (!user && !env.oidc) {
|
|
417
|
-
checks.push(
|
|
435
|
+
checks.push(tokenMissing(ctx, "npm-token", "npm's config has no token and the run has no OIDC token", "npm login on a workstation; in CI, permissions: id-token: write for trusted publishing, or a token in the npm config the job reads.", true));
|
|
418
436
|
}
|
|
419
437
|
// The reveal moves a dist-tag, unless the target publishes straight to latest.
|
|
420
438
|
if (decl.stage !== false && exists) {
|
|
@@ -522,6 +540,10 @@ async function repoAccess(ctx, req) {
|
|
|
522
540
|
const push = res.json?.permissions?.push;
|
|
523
541
|
if (push === true)
|
|
524
542
|
return { check: req.check, status: "ok", message: `the token in ${req.tokenFrom} may write ${req.repo}` };
|
|
543
|
+
// A job's GITHUB_TOKEN is an installation token: the repository API reports no push right for it
|
|
544
|
+
// (absent, or false), whatever the job's permissions grant. The workflow file says what it grants.
|
|
545
|
+
if (ctx.environment.ci === "github" && req.tokenFrom === "GITHUB_TOKEN" && req.forge === "github")
|
|
546
|
+
return jobTokenAccess(ctx, req);
|
|
525
547
|
if (push === false)
|
|
526
548
|
return { check: req.check, status: "fail", message: `the token in ${req.tokenFrom} may read ${req.repo} and not write it`, fix: `Give the token write access to ${req.repo}${req.forge === "github" ? " (contents: write)" : ""}.` };
|
|
527
549
|
const scopes = res.header("x-oauth-scopes");
|
|
@@ -537,6 +559,54 @@ async function repoAccess(ctx, req) {
|
|
|
537
559
|
message: `the token in ${req.tokenFrom} sees ${req.repo}; ${req.api} does not say what this kind of token may write${ctx.environment.ci === "github" && req.tokenFrom === "GITHUB_TOKEN" ? ", and a job token gets contents: write from the workflow's permissions" : ""}`,
|
|
538
560
|
};
|
|
539
561
|
}
|
|
562
|
+
/** The `contents` right the running job's declared `permissions` give its GITHUB_TOKEN, read from the workflow file in the checkout; null when it can't be told. */
|
|
563
|
+
function jobContentsPermission(ctx) {
|
|
564
|
+
const file = ctx.environment.workflow;
|
|
565
|
+
const job = ctx.env.GITHUB_JOB;
|
|
566
|
+
if (!file || !job)
|
|
567
|
+
return { right: null, where: "the workflow file", why: "GITHUB_WORKFLOW_REF or GITHUB_JOB is not set" };
|
|
568
|
+
const abs = join(ctx.env.GITHUB_WORKSPACE || ctx.cwd, file);
|
|
569
|
+
const where = `${file}, job ${job}`;
|
|
570
|
+
let doc;
|
|
571
|
+
try {
|
|
572
|
+
doc = parseYAML(readFileSync(abs, "utf-8"));
|
|
573
|
+
}
|
|
574
|
+
catch {
|
|
575
|
+
return { right: null, where, why: `${file} is not in the checkout, or does not parse` };
|
|
576
|
+
}
|
|
577
|
+
const j = doc.jobs?.[job];
|
|
578
|
+
if (!j || typeof j !== "object")
|
|
579
|
+
return { right: null, where, why: `${file} has no job ${job}` };
|
|
580
|
+
// A job's own `permissions` replaces the workflow's whole; with neither, the repository's default decides.
|
|
581
|
+
const declared = j.permissions !== undefined ? j.permissions : doc.permissions;
|
|
582
|
+
if (declared === undefined || declared === null)
|
|
583
|
+
return { right: null, where, why: "neither the job nor the workflow declares permissions, so the repository's default token permissions apply" };
|
|
584
|
+
if (declared === "write-all")
|
|
585
|
+
return { right: "write", where, why: "" };
|
|
586
|
+
if (declared === "read-all")
|
|
587
|
+
return { right: "read", where, why: "" };
|
|
588
|
+
if (typeof declared !== "object")
|
|
589
|
+
return { right: null, where, why: "its permissions are an expression" };
|
|
590
|
+
const contents = declared.contents;
|
|
591
|
+
if (contents === "write")
|
|
592
|
+
return { right: "write", where, why: "" };
|
|
593
|
+
if (contents === "read")
|
|
594
|
+
return { right: "read", where, why: "" };
|
|
595
|
+
if (contents === undefined || contents === "none")
|
|
596
|
+
return { right: "none", where, why: "" };
|
|
597
|
+
return { right: null, where, why: "its contents permission is an expression" };
|
|
598
|
+
}
|
|
599
|
+
/** What the job's GITHUB_TOKEN may do on the repository: ok or fail from the declared permissions, unknown when they can't be read. Never fail on the API's silence. */
|
|
600
|
+
function jobTokenAccess(ctx, req) {
|
|
601
|
+
const p = jobContentsPermission(ctx);
|
|
602
|
+
if (p.right === "write")
|
|
603
|
+
return { check: req.check, status: "ok", message: `the job's ${req.tokenFrom} may write ${req.repo}: ${p.where} declares contents: write` };
|
|
604
|
+
if (ctx.environment.from === "cut" && p.right !== null)
|
|
605
|
+
return { check: req.check, status: "unknown", message: `this is the cut job, whose ${req.tokenFrom} has contents: ${p.right} (${p.where}); the publish job holds the write the forge target needs, so only a run of the publish job can test this` };
|
|
606
|
+
if (p.right === "read" || p.right === "none")
|
|
607
|
+
return { check: req.check, status: "fail", message: `${p.where} declares contents: ${p.right}, so the job's ${req.tokenFrom} may read ${req.repo} and not write it`, fix: "Give the job permissions: contents: write." };
|
|
608
|
+
return { check: req.check, status: "unknown", message: `the job's ${req.tokenFrom} sees ${req.repo}; the API does not report what an Actions token may write, and ${p.why}` };
|
|
609
|
+
}
|
|
540
610
|
async function checkForge(decl, ctx) {
|
|
541
611
|
const { forgeApi, forgeTokenEnv } = await import("./publish-forge.js");
|
|
542
612
|
const checks = [];
|
|
@@ -814,7 +884,7 @@ async function checkMcpRegistry(decl, ctx) {
|
|
|
814
884
|
// The target reads only GitHub Actions' token service, so no variable stands in for it.
|
|
815
885
|
const tok = await idToken(ctx, audience, "");
|
|
816
886
|
if ("none" in tok) {
|
|
817
|
-
checks.push(
|
|
887
|
+
checks.push(noIdToken(ctx, "mcp-registry-auth", ctx.environment.ci === "github" ? tok.none : "this publish gets its OIDC token from GitHub Actions, and this run is not one", "Give the job permissions: id-token: write."));
|
|
818
888
|
return t;
|
|
819
889
|
}
|
|
820
890
|
const ex = await answer(ctx, `${registry}/v0.1/auth/github-oidc`, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify({ oidc_token: tok.token }) });
|
|
@@ -878,7 +948,7 @@ async function checkMarketplace(decl, ctx) {
|
|
|
878
948
|
}
|
|
879
949
|
const tok = await idToken(ctx, registry, OVSX_ID_TOKEN_ENV);
|
|
880
950
|
if ("none" in tok) {
|
|
881
|
-
checks.push(
|
|
951
|
+
checks.push(noIdToken(ctx, "marketplace-trusted-publisher", tok.none, `Give the job permissions: id-token: write, or put an ID token in ${OVSX_ID_TOKEN_ENV}.`));
|
|
882
952
|
return t;
|
|
883
953
|
}
|
|
884
954
|
const ex = await answer(ctx, `${registry}/api/-/trusted-publishing/token`, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify({ namespace: id.publisher, extension: id.name, token: tok.token }) });
|
|
@@ -946,7 +1016,7 @@ async function checkPypi(decl, ctx) {
|
|
|
946
1016
|
const token = readCredential(ctx.env, [tokenName], ctx.redactor);
|
|
947
1017
|
checks.push(token
|
|
948
1018
|
? { check: "pypi-token", status: "unknown", message: `the token in ${tokenName} is set; ${index.label} has no read-only check of a token, so whether it may upload shows at the upload` }
|
|
949
|
-
:
|
|
1019
|
+
: tokenMissing(ctx, "pypi-token", `${tokenName} is not set${index.site ? " and there is no OIDC ID token for trusted publishing" : ""}`, `Set ${tokenName} to an API token for the project${index.site ? ", or publish with trusted publishing from a CI job with an OIDC ID token" : ""}.`, decl.auth === undefined && index.site !== null));
|
|
950
1020
|
return t;
|
|
951
1021
|
}
|
|
952
1022
|
if (!ctx.environment.ci && !ctx.env[PYPI_ID_TOKEN_ENV]) {
|
|
@@ -961,7 +1031,7 @@ async function checkPypi(decl, ctx) {
|
|
|
961
1031
|
}
|
|
962
1032
|
const tok = await idToken(ctx, audience, PYPI_ID_TOKEN_ENV);
|
|
963
1033
|
if ("none" in tok) {
|
|
964
|
-
checks.push(
|
|
1034
|
+
checks.push(noIdToken(ctx, "pypi-trusted-publisher", tok.none, `Give the job permissions: id-token: write, or declare ${PYPI_ID_TOKEN_ENV} under the GitLab job's id_tokens with the audience ${audience}.`));
|
|
965
1035
|
return t;
|
|
966
1036
|
}
|
|
967
1037
|
const ex = await answer(ctx, `${index.site}/_/oidc/mint-token`, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify({ token: tok.token }) });
|
|
@@ -1056,7 +1126,7 @@ async function checkNuget(decl, ctx) {
|
|
|
1056
1126
|
const tokenName = nugetTokenEnv(decl);
|
|
1057
1127
|
checks.push(readCredential(ctx.env, [tokenName], ctx.redactor)
|
|
1058
1128
|
? { check: "nuget-token", status: "unknown", message: `the API key in ${tokenName} is set; ${feed.label} has no read-only check of a key, so whether it may push shows at the push` }
|
|
1059
|
-
:
|
|
1129
|
+
: tokenMissing(ctx, "nuget-token", `${tokenName} is not set${feed.nugetOrg ? " and there is no OIDC ID token for trusted publishing" : ""}`, `Set ${tokenName} to an API key that may push the packages${feed.nugetOrg ? ", or publish with trusted publishing from a CI job with an OIDC ID token" : ""}.`, decl.auth === undefined && Boolean(feed.nugetOrg)));
|
|
1060
1130
|
return t;
|
|
1061
1131
|
}
|
|
1062
1132
|
const userName = nugetUserEnv(decl);
|
|
@@ -1071,7 +1141,7 @@ async function checkNuget(decl, ctx) {
|
|
|
1071
1141
|
}
|
|
1072
1142
|
const tok = await idToken(ctx, NUGET_AUDIENCE, NUGET_ID_TOKEN_ENV);
|
|
1073
1143
|
if ("none" in tok) {
|
|
1074
|
-
checks.push(
|
|
1144
|
+
checks.push(noIdToken(ctx, "nuget-trusted-publisher", tok.none, `Give the job permissions: id-token: write, or declare ${NUGET_ID_TOKEN_ENV} under the GitLab job's id_tokens with aud: ${NUGET_AUDIENCE}.`));
|
|
1075
1145
|
return t;
|
|
1076
1146
|
}
|
|
1077
1147
|
const ex = await answer(ctx, NUGET_ORG.token, { method: "POST", headers: { "content-type": "application/json", authorization: `Bearer ${tok.token}` }, body: JSON.stringify({ username: user.value, tokenType: "ApiKey" }) });
|
|
@@ -1121,7 +1191,7 @@ async function checkRubygems(decl, ctx) {
|
|
|
1121
1191
|
const tokenName = rubygemsTokenEnv(decl);
|
|
1122
1192
|
checks.push(readCredential(ctx.env, [tokenName], ctx.redactor)
|
|
1123
1193
|
? { check: "rubygems-token", status: "unknown", message: `the API key in ${tokenName} is set; ${label} has no read-only check of a key, so whether it may push shows at the push` }
|
|
1124
|
-
:
|
|
1194
|
+
: tokenMissing(ctx, "rubygems-token", `${tokenName} is not set${decl.host ? "" : " and there is no OIDC ID token for trusted publishing"}`, `Set ${tokenName} to an API key with the push scope${decl.host ? "" : ", or publish with trusted publishing from a GitHub Actions job with id-token: write"}.`, decl.auth === undefined && !decl.host));
|
|
1125
1195
|
return t;
|
|
1126
1196
|
}
|
|
1127
1197
|
if (!ctx.environment.ci && !ctx.env[RUBYGEMS_ID_TOKEN_ENV]) {
|
|
@@ -1130,7 +1200,7 @@ async function checkRubygems(decl, ctx) {
|
|
|
1130
1200
|
}
|
|
1131
1201
|
const tok = await idToken(ctx, RUBYGEMS_AUDIENCE, RUBYGEMS_ID_TOKEN_ENV);
|
|
1132
1202
|
if ("none" in tok) {
|
|
1133
|
-
checks.push(
|
|
1203
|
+
checks.push(noIdToken(ctx, "rubygems-trusted-publisher", tok.none, "Give the job permissions: id-token: write."));
|
|
1134
1204
|
return t;
|
|
1135
1205
|
}
|
|
1136
1206
|
const ex = await answer(ctx, `${host}/api/v1/oidc/trusted_publisher/exchange_token`, { method: "POST", headers: { "content-type": "application/json", accept: "application/json" }, body: JSON.stringify({ jwt: tok.token }) });
|
|
@@ -1172,7 +1242,7 @@ async function checkCargo(decl, ctx) {
|
|
|
1172
1242
|
if (auth === "token") {
|
|
1173
1243
|
const tokenName = cargoTokenEnv(decl);
|
|
1174
1244
|
const token = readCredential(ctx.env, [tokenName], ctx.redactor);
|
|
1175
|
-
checks.push(token ? { check: "cargo-token", status: "unknown", message: `the token in ${tokenName} is set; ${label} has no read-only check of a token, so whether it may publish shows at the publish` } :
|
|
1245
|
+
checks.push(token ? { check: "cargo-token", status: "unknown", message: `the token in ${tokenName} is set; ${label} has no read-only check of a token, so whether it may publish shows at the publish` } : tokenMissing(ctx, "cargo-token", `${tokenName} is not set`, `Set ${tokenName} to a token of ${label}.`, decl.auth === undefined && decl.registry === undefined));
|
|
1176
1246
|
return t;
|
|
1177
1247
|
}
|
|
1178
1248
|
if (!ctx.environment.ci && !ctx.env[CRATES_IO_ID_TOKEN_ENV]) {
|
|
@@ -1181,7 +1251,7 @@ async function checkCargo(decl, ctx) {
|
|
|
1181
1251
|
}
|
|
1182
1252
|
const tok = await idToken(ctx, CRATES_IO_AUDIENCE, CRATES_IO_ID_TOKEN_ENV);
|
|
1183
1253
|
if ("none" in tok) {
|
|
1184
|
-
checks.push(
|
|
1254
|
+
checks.push(noIdToken(ctx, "cargo-trusted-publisher", tok.none, "Give the job permissions: id-token: write."));
|
|
1185
1255
|
return t;
|
|
1186
1256
|
}
|
|
1187
1257
|
const api = (decl.api ?? CRATES_IO_API).replace(/\/+$/, "");
|
|
@@ -6,8 +6,11 @@
|
|
|
6
6
|
* `ci/revoked/<sha>` tag, as `chant ci` writes them from `ci.green`
|
|
7
7
|
* (./release-cut.ts). The default when `chant.workspace.json` declares
|
|
8
8
|
* `ci.green` or the repository holds any `ci/green/` tag.
|
|
9
|
-
* - `forge-checks`: the forge's checks on the commit passed.
|
|
10
|
-
*
|
|
9
|
+
* - `forge-checks`: the forge's checks on the commit passed. Each check is
|
|
10
|
+
* judged by its newest run on the commit (GitHub: per check name and app,
|
|
11
|
+
* and per status context; newest completion time, ties by highest id), so
|
|
12
|
+
* a failed merge_group run followed by a passing push run is green.
|
|
13
|
+
* GitHub: every check run and commit status, and each check a branch rule of the
|
|
11
14
|
* branch requires. Forgejo: every commit status, and each context its
|
|
12
15
|
* branch protection requires when the token can read it. GitLab: the
|
|
13
16
|
* newest pipeline of each source on the commit. A check that failed or has
|
|
@@ -6,8 +6,11 @@
|
|
|
6
6
|
* `ci/revoked/<sha>` tag, as `chant ci` writes them from `ci.green`
|
|
7
7
|
* (./release-cut.ts). The default when `chant.workspace.json` declares
|
|
8
8
|
* `ci.green` or the repository holds any `ci/green/` tag.
|
|
9
|
-
* - `forge-checks`: the forge's checks on the commit passed.
|
|
10
|
-
*
|
|
9
|
+
* - `forge-checks`: the forge's checks on the commit passed. Each check is
|
|
10
|
+
* judged by its newest run on the commit (GitHub: per check name and app,
|
|
11
|
+
* and per status context; newest completion time, ties by highest id), so
|
|
12
|
+
* a failed merge_group run followed by a passing push run is green.
|
|
13
|
+
* GitHub: every check run and commit status, and each check a branch rule of the
|
|
11
14
|
* branch requires. Forgejo: every commit status, and each context its
|
|
12
15
|
* branch protection requires when the token can read it. GitLab: the
|
|
13
16
|
* newest pipeline of each source on the commit. A check that failed or has
|
|
@@ -78,6 +81,25 @@ export function judgeChecks(forge, checks, required) {
|
|
|
78
81
|
return { green: false, forge, checks, why: `the branch requires ${missing.join(", ")}, which ${forge} does not report on it` };
|
|
79
82
|
return { green: true, forge, checks: [...names].sort() };
|
|
80
83
|
}
|
|
84
|
+
const num = (v) => (typeof v === "number" ? v : typeof v === "string" && /^\d+$/.test(v) ? Number(v) : 0);
|
|
85
|
+
const time = (...vs) => {
|
|
86
|
+
for (const v of vs) {
|
|
87
|
+
const t = typeof v === "string" ? Date.parse(v) : NaN;
|
|
88
|
+
if (!Number.isNaN(t))
|
|
89
|
+
return t;
|
|
90
|
+
}
|
|
91
|
+
return 0;
|
|
92
|
+
};
|
|
93
|
+
/** The newest reading of each key: latest time, ties by highest id. A rerun, or a later run on the same commit, supersedes the one before it, as in GitHub's own rollup. */
|
|
94
|
+
function newestRuns(readings) {
|
|
95
|
+
const out = new Map();
|
|
96
|
+
for (const r of readings) {
|
|
97
|
+
const had = out.get(r.key);
|
|
98
|
+
if (!had || r.at > had.at || (r.at === had.at && r.id > had.id))
|
|
99
|
+
out.set(r.key, r);
|
|
100
|
+
}
|
|
101
|
+
return [...out.values()].map((r) => r.check);
|
|
102
|
+
}
|
|
81
103
|
const isObject = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
|
|
82
104
|
const str = (v) => (typeof v === "string" ? v : undefined);
|
|
83
105
|
/** Whether `url` is a page of one of the CI runs `runIds` (`.../actions/runs/<id>` or `.../actions/runs/<id>/...`). */
|
|
@@ -138,7 +160,7 @@ export function forgeChecksReader(target, env = process.env, fetchImpl) {
|
|
|
138
160
|
runId.add(String(r.id));
|
|
139
161
|
}
|
|
140
162
|
}
|
|
141
|
-
const
|
|
163
|
+
const runReadings = [];
|
|
142
164
|
for (let page = 1; page <= 20; page++) {
|
|
143
165
|
const got = await get(`${repo}/commits/${sha}/check-runs?per_page=100&page=${page}`);
|
|
144
166
|
const runs = isObject(got) && Array.isArray(got.check_runs) ? got.check_runs.filter(isObject) : [];
|
|
@@ -149,20 +171,29 @@ export function forgeChecksReader(target, env = process.env, fetchImpl) {
|
|
|
149
171
|
continue;
|
|
150
172
|
const status = str(r.status) ?? "unknown";
|
|
151
173
|
const conclusion = str(r.conclusion) ?? null;
|
|
152
|
-
|
|
174
|
+
const app = isObject(r.app) ? String(r.app.id ?? r.app.slug ?? "") : "";
|
|
175
|
+
runReadings.push({
|
|
176
|
+
key: `${app}\0${name}`,
|
|
177
|
+
at: time(r.completed_at, r.started_at),
|
|
178
|
+
id: num(r.id),
|
|
179
|
+
check: { name, state: checkState(status, conclusion), status: status === "completed" ? (conclusion ?? status) : status, ...(url ? { url } : {}) },
|
|
180
|
+
});
|
|
153
181
|
}
|
|
154
182
|
if (runs.length < 100)
|
|
155
183
|
break;
|
|
156
184
|
}
|
|
185
|
+
const checks = newestRuns(runReadings);
|
|
157
186
|
const combined = await get(`${repo}/commits/${sha}/status?per_page=100`);
|
|
187
|
+
const statusReadings = [];
|
|
158
188
|
for (const s of isObject(combined) && Array.isArray(combined.statuses) ? combined.statuses.filter(isObject) : []) {
|
|
159
189
|
const name = str(s.context);
|
|
160
190
|
const url = str(s.target_url);
|
|
161
191
|
if (!name || inRun(url, runId))
|
|
162
192
|
continue;
|
|
163
193
|
const state = str(s.state) ?? "unknown";
|
|
164
|
-
|
|
194
|
+
statusReadings.push({ key: name, at: time(s.updated_at, s.created_at), id: num(s.id), check: { name, state: state === "error" ? "failure" : checkState(state), status: state, ...(url ? { url } : {}) } });
|
|
165
195
|
}
|
|
196
|
+
checks.push(...newestRuns(statusReadings));
|
|
166
197
|
const required = [];
|
|
167
198
|
if (branch) {
|
|
168
199
|
const rules = await get(`${repo}/rules/branches/${encodeURIComponent(branch)}`, true);
|
|
@@ -185,15 +216,16 @@ export function forgeChecksReader(target, env = process.env, fetchImpl) {
|
|
|
185
216
|
const repo = `/repos/${target.repo}`;
|
|
186
217
|
return async (sha, branch) => {
|
|
187
218
|
const combined = await get(`${repo}/commits/${sha}/status?limit=100`);
|
|
188
|
-
const
|
|
219
|
+
const readings = [];
|
|
189
220
|
for (const s of isObject(combined) && Array.isArray(combined.statuses) ? combined.statuses.filter(isObject) : []) {
|
|
190
221
|
const name = str(s.context);
|
|
191
222
|
const url = str(s.target_url);
|
|
192
223
|
if (!name || inRun(url, runNumber))
|
|
193
224
|
continue;
|
|
194
225
|
const state = str(s.status) ?? str(s.state) ?? "unknown";
|
|
195
|
-
|
|
226
|
+
readings.push({ key: name, at: time(s.updated_at, s.created_at), id: num(s.id), check: { name, state: state === "error" ? "failure" : checkState(state), status: state, ...(url ? { url } : {}) } });
|
|
196
227
|
}
|
|
228
|
+
const checks = newestRuns(readings);
|
|
197
229
|
const required = [];
|
|
198
230
|
if (branch) {
|
|
199
231
|
const protections = await get(`${repo}/branch_protections`, true);
|
|
@@ -233,7 +265,7 @@ export function forgeChecksReader(target, env = process.env, fetchImpl) {
|
|
|
233
265
|
return judgeChecks("gitlab", checks, []);
|
|
234
266
|
};
|
|
235
267
|
}
|
|
236
|
-
/** Each check name once, at the worst state any entry of that name has, so a check run and a status of the same name can't hide a failure. */
|
|
268
|
+
/** Each check name once, at the worst state any entry of that name has, so a check run and a status of the same name can't hide a failure. Reruns of one check are already collapsed to the newest by `newestRuns`. */
|
|
237
269
|
function newestByName(checks) {
|
|
238
270
|
const rank = { failure: 2, pending: 1, success: 0 };
|
|
239
271
|
const out = new Map();
|
|
@@ -48,6 +48,13 @@ export declare const RELEASE_IMAGES_FLOOR = "0.124.71";
|
|
|
48
48
|
export declare const RELEASE_IMAGE_DOCKERFILE_FLOOR = "0.124.78";
|
|
49
49
|
/** The first chant whose Dockerfile entry in `release.images` takes `args`, build arguments beside the two chant passes (#4908). */
|
|
50
50
|
export declare const RELEASE_IMAGE_ARGS_FLOOR = "0.124.88";
|
|
51
|
+
/**
|
|
52
|
+
* The first chant whose Dockerfile entry takes `labels`, OCI labels on the
|
|
53
|
+
* image, and `{label}` and `{version}` in `args` and `labels` values, and
|
|
54
|
+
* whose image builds see `CHANT_RELEASE_VERSION`; and whose default archive
|
|
55
|
+
* moves out of a goreleaser entry's `dist` (#5269).
|
|
56
|
+
*/
|
|
57
|
+
export declare const RELEASE_IMAGE_LABELS_FLOOR = "0.124.104";
|
|
51
58
|
/** One image a release builds in its cut with a command of the product's. */
|
|
52
59
|
export interface ReleaseImageBuild {
|
|
53
60
|
/** The image's name: its key in the digests file, and its artifact's `component` in the release. */
|
|
@@ -80,9 +87,17 @@ export interface ReleaseImageDockerfile {
|
|
|
80
87
|
* Build arguments beside `SOURCE_DATE_EPOCH` and `CHANT_RELEASE_LABEL`
|
|
81
88
|
* (#4908), such as the packed package's file and the chant packages the
|
|
82
89
|
* image installs beside it, as sql-yodeler's `release-image.sh` passed
|
|
83
|
-
* them.
|
|
90
|
+
* them. `{label}` in a value is the release's label and `{version}` the
|
|
91
|
+
* label from its first digit (#5269), such as `{ VERSION: "{version}" }`;
|
|
92
|
+
* the rest is literal.
|
|
84
93
|
*/
|
|
85
94
|
args?: Record<string, string>;
|
|
95
|
+
/**
|
|
96
|
+
* OCI labels on the image (#5269), such as
|
|
97
|
+
* `{ "org.opencontainers.image.version": "{version}" }`, with the same
|
|
98
|
+
* placeholders as `args`.
|
|
99
|
+
*/
|
|
100
|
+
labels?: Record<string, string>;
|
|
86
101
|
}
|
|
87
102
|
/** One image a release builds in its cut. */
|
|
88
103
|
export type ReleaseImageDeclaration = ReleaseImageBuild | ReleaseImageDockerfile;
|
|
@@ -100,6 +115,20 @@ export declare const RELEASE_IMAGE_BUILDER = "chant-release";
|
|
|
100
115
|
export declare function releaseImageBuildCommand(i: ReleaseImageDockerfile, o?: {
|
|
101
116
|
versionArg?: boolean;
|
|
102
117
|
}): string;
|
|
118
|
+
/** The archive of a Dockerfile entry that names none and whose default would be inside a goreleaser entry's `dist` (#5269). */
|
|
119
|
+
export declare const imageArchiveBesideGoreleaser: (name: string) => string;
|
|
120
|
+
/**
|
|
121
|
+
* A member's `release.images` with each archive placed (#5269). goreleaser
|
|
122
|
+
* empties its `dist` (`--clean`) when it builds, after the images, so an
|
|
123
|
+
* archive there would be gone before the cut records it: a Dockerfile entry
|
|
124
|
+
* that names no archive, whose default `dist/images/<name>.tar` is inside a
|
|
125
|
+
* goreleaser entry's `dist`, writes {@link imageArchiveBesideGoreleaser}
|
|
126
|
+
* instead. An archive named inside it is left for
|
|
127
|
+
* {@link checkImagesOutsideGoreleaser} to refuse.
|
|
128
|
+
*/
|
|
129
|
+
export declare function placeReleaseImages(images: readonly ReleaseImageDeclaration[], artifacts?: readonly unknown[]): ReleaseImageDeclaration[];
|
|
130
|
+
/** Refuse an image archive inside a goreleaser entry's `dist` (#5269), which goreleaser empties after the images are built. */
|
|
131
|
+
export declare function checkImagesOutsideGoreleaser(images: readonly ReleaseImageDeclaration[], artifacts?: readonly unknown[]): void;
|
|
103
132
|
/** Each entry as a command and an archive: a Dockerfile entry's command is {@link releaseImageBuildCommand}, its archive the default when it names none. */
|
|
104
133
|
export declare function resolveReleaseImages(images: readonly ReleaseImageDeclaration[], o?: {
|
|
105
134
|
versionArg?: boolean;
|
|
@@ -115,7 +144,13 @@ export declare class ReleaseImageError extends Error {
|
|
|
115
144
|
readonly fix?: string | undefined;
|
|
116
145
|
constructor(code: string, message: string, fix?: string | undefined);
|
|
117
146
|
}
|
|
118
|
-
/**
|
|
147
|
+
/**
|
|
148
|
+
* Check a member's `release.images`: names valid and unique, one of `build`
|
|
149
|
+
* and `dockerfile`, the archive inside the member, platforms of the form
|
|
150
|
+
* os/arch. The Dockerfile and the context, which the build only reads, may
|
|
151
|
+
* leave the member with `..` (#5271), so a member at `release/<name>` builds
|
|
152
|
+
* the repository root's Dockerfile.
|
|
153
|
+
*/
|
|
119
154
|
export declare function checkReleaseImages(images: readonly ReleaseImageDeclaration[]): void;
|
|
120
155
|
/** The digest of an OCI archive: its top manifest's, as `index.json` names it. */
|
|
121
156
|
export type ArchiveDigest = (abs: string) => string;
|
|
@@ -142,7 +177,8 @@ export interface BuildImagesInput {
|
|
|
142
177
|
/**
|
|
143
178
|
* Build each image and return it as the release's image artifact. The
|
|
144
179
|
* command runs with `SOURCE_DATE_EPOCH` and, for a cut with a label,
|
|
145
|
-
* `CHANT_RELEASE_LABEL
|
|
180
|
+
* `CHANT_RELEASE_LABEL` and `CHANT_RELEASE_VERSION` (the label from its
|
|
181
|
+
* first digit, when it has one); an archive it did not write, or a command that
|
|
146
182
|
* fails, stops the cut.
|
|
147
183
|
*/
|
|
148
184
|
export declare function buildReleaseImages(i: BuildImagesInput): ReleaseArtifact[];
|
|
@@ -49,6 +49,13 @@ export const RELEASE_IMAGES_FLOOR = "0.124.71";
|
|
|
49
49
|
export const RELEASE_IMAGE_DOCKERFILE_FLOOR = "0.124.78";
|
|
50
50
|
/** The first chant whose Dockerfile entry in `release.images` takes `args`, build arguments beside the two chant passes (#4908). */
|
|
51
51
|
export const RELEASE_IMAGE_ARGS_FLOOR = "0.124.88";
|
|
52
|
+
/**
|
|
53
|
+
* The first chant whose Dockerfile entry takes `labels`, OCI labels on the
|
|
54
|
+
* image, and `{label}` and `{version}` in `args` and `labels` values, and
|
|
55
|
+
* whose image builds see `CHANT_RELEASE_VERSION`; and whose default archive
|
|
56
|
+
* moves out of a goreleaser entry's `dist` (#5269).
|
|
57
|
+
*/
|
|
58
|
+
export const RELEASE_IMAGE_LABELS_FLOOR = "0.124.104";
|
|
52
59
|
/** The platforms a Dockerfile entry builds by default. Building arm64 on amd64 needs QEMU's binfmt handlers. */
|
|
53
60
|
export const RELEASE_IMAGE_PLATFORMS = ["linux/amd64", "linux/arm64"];
|
|
54
61
|
/** The buildx builder a Dockerfile entry builds with, created with the `docker-container` driver when missing: the default driver cannot rewrite timestamps in an OCI archive. */
|
|
@@ -58,6 +65,14 @@ const PLATFORM = /^[a-z0-9]+\/[a-z0-9_]+(?:\/[a-z0-9]+)?$/;
|
|
|
58
65
|
const sh = (s) => (/^[A-Za-z0-9_./:=,@+%-]+$/.test(s) ? s : `'${s.replace(/'/g, "'\\''")}'`);
|
|
59
66
|
const isDockerfile = (i) => "dockerfile" in i && i.dockerfile !== undefined;
|
|
60
67
|
const archiveOf = (i) => i.archive ?? `dist/images/${i.name}.tar`;
|
|
68
|
+
/** The placeholders an `args` or `labels` value takes (#5269), each the variable the build command reads. */
|
|
69
|
+
const PLACEHOLDERS = { "{label}": '"$CHANT_RELEASE_LABEL"', "{version}": '"$CHANT_RELEASE_VERSION"' };
|
|
70
|
+
/** `s` as one shell word, its `{label}` and `{version}` read from the build's environment (#5269). */
|
|
71
|
+
const word = (s) => s
|
|
72
|
+
.split(/(\{label\}|\{version\})/)
|
|
73
|
+
.filter((p) => p.length > 0)
|
|
74
|
+
.map((p) => PLACEHOLDERS[p] ?? sh(p))
|
|
75
|
+
.join("");
|
|
61
76
|
/**
|
|
62
77
|
* The shell command a Dockerfile entry builds with (#4819), the one
|
|
63
78
|
* terragucci's and plywood's `scripts/release-image.sh` ran: `--no-cache`,
|
|
@@ -74,12 +89,52 @@ export function releaseImageBuildCommand(i, o = {}) {
|
|
|
74
89
|
[
|
|
75
90
|
`docker buildx build --builder ${b} --no-cache --platform ${sh((i.platforms ?? RELEASE_IMAGE_PLATFORMS).join(","))}`,
|
|
76
91
|
`--provenance=false --sbom=false --build-arg SOURCE_DATE_EPOCH="$SOURCE_DATE_EPOCH"${o.versionArg ? ' --build-arg CHANT_RELEASE_LABEL="$CHANT_RELEASE_LABEL"' : ""}${Object.entries(i.args ?? {})
|
|
77
|
-
.map(([k, v]) => ` --build-arg ${
|
|
92
|
+
.map(([k, v]) => ` --build-arg ${word(`${k}=${v}`)}`)
|
|
93
|
+
.join("")}${Object.entries(i.labels ?? {})
|
|
94
|
+
.map(([k, v]) => ` --label ${word(`${k}=${v}`)}`)
|
|
78
95
|
.join("")}`,
|
|
79
96
|
`--output ${sh(`type=oci,dest=${archive},rewrite-timestamp=true`)} -f ${sh(i.dockerfile)} ${sh(i.context ?? ".")} >&2`,
|
|
80
97
|
].join(" "),
|
|
81
98
|
].join(" && ");
|
|
82
99
|
}
|
|
100
|
+
/** The archive of a Dockerfile entry that names none and whose default would be inside a goreleaser entry's `dist` (#5269). */
|
|
101
|
+
export const imageArchiveBesideGoreleaser = (name) => `build/images/${name}.tar`;
|
|
102
|
+
/** `p` is `dir` or inside it, both relative to the member. */
|
|
103
|
+
const within = (p, dir) => {
|
|
104
|
+
const a = posix.normalize(p.replace(/\\/g, "/"));
|
|
105
|
+
const d = posix.normalize(dir.replace(/\\/g, "/")).replace(/\/$/, "");
|
|
106
|
+
return d === "." || a === d || a.startsWith(`${d}/`);
|
|
107
|
+
};
|
|
108
|
+
/** The `dist` directory of each goreleaser entry in `release.artifacts` (#5269). */
|
|
109
|
+
const goreleaserDists = (artifacts) => artifacts.flatMap((a) => {
|
|
110
|
+
const g = a?.goreleaser;
|
|
111
|
+
return g && typeof g === "object" ? [typeof g.dist === "string" ? g.dist : "dist"] : [];
|
|
112
|
+
});
|
|
113
|
+
/**
|
|
114
|
+
* A member's `release.images` with each archive placed (#5269). goreleaser
|
|
115
|
+
* empties its `dist` (`--clean`) when it builds, after the images, so an
|
|
116
|
+
* archive there would be gone before the cut records it: a Dockerfile entry
|
|
117
|
+
* that names no archive, whose default `dist/images/<name>.tar` is inside a
|
|
118
|
+
* goreleaser entry's `dist`, writes {@link imageArchiveBesideGoreleaser}
|
|
119
|
+
* instead. An archive named inside it is left for
|
|
120
|
+
* {@link checkImagesOutsideGoreleaser} to refuse.
|
|
121
|
+
*/
|
|
122
|
+
export function placeReleaseImages(images, artifacts = []) {
|
|
123
|
+
const dists = goreleaserDists(artifacts);
|
|
124
|
+
if (dists.length === 0)
|
|
125
|
+
return [...images];
|
|
126
|
+
return images.map((i) => (isDockerfile(i) && i.archive === undefined && dists.some((d) => within(archiveOf(i), d)) ? { ...i, archive: imageArchiveBesideGoreleaser(i.name) } : i));
|
|
127
|
+
}
|
|
128
|
+
/** Refuse an image archive inside a goreleaser entry's `dist` (#5269), which goreleaser empties after the images are built. */
|
|
129
|
+
export function checkImagesOutsideGoreleaser(images, artifacts = []) {
|
|
130
|
+
const dists = goreleaserDists(artifacts);
|
|
131
|
+
for (const i of images) {
|
|
132
|
+
const dist = dists.find((d) => within(archiveOf(i), d));
|
|
133
|
+
if (dist === undefined)
|
|
134
|
+
continue;
|
|
135
|
+
throw new ReleaseImageError("release-image-archive-in-dist", `release.images "${i.name}": the archive ${archiveOf(i)} is inside ${dist}, which goreleaser empties when it builds the release's files, after the images`, `Write it outside ${dist}, such as archive: "${imageArchiveBesideGoreleaser(i.name)}".`);
|
|
136
|
+
}
|
|
137
|
+
}
|
|
83
138
|
/** Each entry as a command and an archive: a Dockerfile entry's command is {@link releaseImageBuildCommand}, its archive the default when it names none. */
|
|
84
139
|
export function resolveReleaseImages(images, o = {}) {
|
|
85
140
|
return images.map((i) => (isDockerfile(i) ? { name: i.name, build: releaseImageBuildCommand(i, o), archive: archiveOf(i) } : i));
|
|
@@ -102,10 +157,17 @@ export class ReleaseImageError extends Error {
|
|
|
102
157
|
}
|
|
103
158
|
const NAME = /^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$/;
|
|
104
159
|
const BUILD_ARG = /^[A-Za-z_][A-Za-z0-9_]*$/;
|
|
160
|
+
const LABEL_KEY = /^[A-Za-z0-9][A-Za-z0-9._\/-]*$/;
|
|
105
161
|
/** The build arguments chant passes itself, which an entry's `args` cannot set. */
|
|
106
162
|
const CHANT_BUILD_ARGS = ["SOURCE_DATE_EPOCH", "CHANT_RELEASE_LABEL"];
|
|
107
163
|
const outside = (p) => isAbsolute(p) || p.split(/[\\/]/).includes("..");
|
|
108
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* Check a member's `release.images`: names valid and unique, one of `build`
|
|
166
|
+
* and `dockerfile`, the archive inside the member, platforms of the form
|
|
167
|
+
* os/arch. The Dockerfile and the context, which the build only reads, may
|
|
168
|
+
* leave the member with `..` (#5271), so a member at `release/<name>` builds
|
|
169
|
+
* the repository root's Dockerfile.
|
|
170
|
+
*/
|
|
109
171
|
export function checkReleaseImages(images) {
|
|
110
172
|
const seen = new Set();
|
|
111
173
|
for (const i of images) {
|
|
@@ -116,10 +178,19 @@ export function checkReleaseImages(images) {
|
|
|
116
178
|
seen.add(i.name);
|
|
117
179
|
if (isDockerfile(i) && "build" in i)
|
|
118
180
|
throw new ReleaseImageError("release-image-invalid", `release.images "${i.name}" names a build command and a Dockerfile; chant builds a Dockerfile itself, so name one`);
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
181
|
+
if (outside(archiveOf(i)))
|
|
182
|
+
throw new ReleaseImageError("release-image-archive-outside", `release.images "${i.name}": the archive ${archiveOf(i)} is not a path inside the member`);
|
|
183
|
+
if (isDockerfile(i)) {
|
|
184
|
+
for (const [what, p] of [["the Dockerfile", i.dockerfile], ["the context", i.context]]) {
|
|
185
|
+
if (p !== undefined && isAbsolute(p))
|
|
186
|
+
throw new ReleaseImageError("release-image-archive-outside", `release.images "${i.name}": ${what} ${p} is an absolute path; name it relative to the member`);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
for (const [k, v] of Object.entries((isDockerfile(i) && i.labels) || {})) {
|
|
190
|
+
if (!LABEL_KEY.test(k))
|
|
191
|
+
throw new ReleaseImageError("release-image-invalid", `release.images "${i.name}": labels names ${JSON.stringify(k)}, which is not a label key such as org.opencontainers.image.version`);
|
|
192
|
+
if (typeof v !== "string" || /[\r\n]/.test(v))
|
|
193
|
+
throw new ReleaseImageError("release-image-invalid", `release.images "${i.name}": labels.${k} is not a one-line string`);
|
|
123
194
|
}
|
|
124
195
|
for (const [k, v] of Object.entries((isDockerfile(i) && i.args) || {})) {
|
|
125
196
|
if (!BUILD_ARG.test(k))
|
|
@@ -138,7 +209,8 @@ const defaultRun = (command, o) => spawnSync(command, { cwd: o.cwd, env: o.env,
|
|
|
138
209
|
/**
|
|
139
210
|
* Build each image and return it as the release's image artifact. The
|
|
140
211
|
* command runs with `SOURCE_DATE_EPOCH` and, for a cut with a label,
|
|
141
|
-
* `CHANT_RELEASE_LABEL
|
|
212
|
+
* `CHANT_RELEASE_LABEL` and `CHANT_RELEASE_VERSION` (the label from its
|
|
213
|
+
* first digit, when it has one); an archive it did not write, or a command that
|
|
142
214
|
* fails, stops the cut.
|
|
143
215
|
*/
|
|
144
216
|
export function buildReleaseImages(i) {
|
|
@@ -148,8 +220,13 @@ export function buildReleaseImages(i) {
|
|
|
148
220
|
const envFor = () => {
|
|
149
221
|
const env = { ...(i.env ?? process.env), SOURCE_DATE_EPOCH: String(i.sourceDateEpoch) };
|
|
150
222
|
delete env.CHANT_RELEASE_LABEL;
|
|
223
|
+
delete env.CHANT_RELEASE_VERSION;
|
|
151
224
|
if (i.label !== null)
|
|
152
225
|
env.CHANT_RELEASE_LABEL = i.label;
|
|
226
|
+
// #5269: the label from its first digit, for an entry's {version}.
|
|
227
|
+
const at = i.label?.search(/\d/) ?? -1;
|
|
228
|
+
if (i.label !== null && at >= 0)
|
|
229
|
+
env.CHANT_RELEASE_VERSION = i.label.slice(at);
|
|
153
230
|
return env;
|
|
154
231
|
};
|
|
155
232
|
// #4819: each prepare command once, before any build, with no digests file, as the image's contents are built in the cut and the publish job alike.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/** The image a goreleaser config builds, as `release init` declares it. */
|
|
2
|
+
export interface GoreleaserImage {
|
|
3
|
+
/** The `release.images` entry's name: the repository's last segment. */
|
|
4
|
+
name: string;
|
|
5
|
+
repository: string;
|
|
6
|
+
dockerfile: string;
|
|
7
|
+
platforms: string[];
|
|
8
|
+
args: Record<string, string>;
|
|
9
|
+
labels: Record<string, string>;
|
|
10
|
+
/** The oci target's tags. */
|
|
11
|
+
tags: string[];
|
|
12
|
+
/** The oci target's `platformTags`, such as `{version}-{arch}`. */
|
|
13
|
+
platformTags: string[];
|
|
14
|
+
archive: string;
|
|
15
|
+
/** The goreleaser keys the plan replaces, to remove from the config. */
|
|
16
|
+
keys: string[];
|
|
17
|
+
/** What was not carried, each in words. */
|
|
18
|
+
unread: string[];
|
|
19
|
+
}
|
|
20
|
+
/** The image a goreleaser config builds, or null when it builds none with `dockers` or `dockers_v2`. */
|
|
21
|
+
export declare function goreleaserImage(text: string): GoreleaserImage | null;
|