@ship.zone/ci-spec 2.0.0 → 2.1.1

package/ts/constants.ts

@@ -94,6 +94,69 @@ export const compilationFailureCodes = [
   { code: 'secret_too_short', layer: 'run' },
 ] as const;
 
+/**
+ * The prefix of every environment name the specification reserves (spec/ci-actions.md, Jobs and
+ * Steps; spec/runner-protocol.md, OCI Container Profile): workflow authors cannot define a name
+ * with it, and a compiled job carries only the reserved step variables with it.
+ */
+export const reservedEnvironmentPrefix = 'SHIPZONE_CI_' as const;
+
+/** The matrix values of a compiled step, as RFC 8785 JSON object text (spec/ci-actions.md, Matrix). */
+export const matrixEnvironmentName = 'SHIPZONE_CI_MATRIX_JSON' as const;
+
+/** The manual inputs of a run, as RFC 8785 JSON object text (spec/ci-actions.md, Matrix). */
+export const inputsEnvironmentName = 'SHIPZONE_CI_INPUTS_JSON' as const;
+
+/**
+ * The reserved variables every compiled `oci` and `vm` step carries (spec/runner-protocol.md, OCI
+ * Container Profile).
+ */
+export const reservedStepEnvironmentNames = [matrixEnvironmentName, inputsEnvironmentName] as const;
+
+/**
+ * The environment name through which a runner delivers npm read grants to `oci` and `vm` steps,
+ * reserved in a job with `npmRead` (spec/runner-protocol.md, npm Read Grants).
+ */
+export const npmUserConfigEnvironmentName = 'NPM_CONFIG_USERCONFIG' as const;
+
+/**
+ * The BuildKit secret id through which a runner delivers npm read grants to an `oci-image` build,
+ * reserved in a job with `npmRead` (spec/runner-protocol.md, npm Read Grants).
+ */
+export const npmBuildSecretId = 'npmrc' as const;
+
+/** The prefix of the image label keys reserved for the coordinator (spec/ci-actions.md, Image Builds). */
+export const reservedImageLabelPrefix = 'zone.ship.ci.' as const;
+
+/**
+ * The image label keys reserved for the coordinator besides the reserved prefix (spec/ci-actions.md,
+ * Image Builds). The coordinator compiles `revision` and `source` into every build job and `version`
+ * on a run with a tag version (spec/ci-actions.md, Compiled Jobs).
+ */
+export const reservedImageLabelKeys = [
+  'org.opencontainers.image.revision',
+  'org.opencontainers.image.source',
+  'org.opencontainers.image.version',
+] as const;
+
+/**
+ * Every runner job failure code in precedence order, mirrored from
+ * `conformance/runner-job-cases.json` `failureCodes`: the code a coordinator or runner reports for a
+ * compiled job that is not coherent (spec/runner-protocol.md, Job Coherence). The conformance tests
+ * assert both sources and the prose table agree.
+ */
+export const runnerJobFailureCodes = [
+  'spec_incompatible',
+  'job_schema_invalid',
+  'job_secret_incoherent',
+  'job_limit_incoherent',
+  'job_resources_incoherent',
+  'job_environment_incoherent',
+  'job_command_limit_exceeded',
+  'job_secret_inadmissible',
+  'job_digest_mismatch',
+] as const;
+
 export const ciSpecAssetPaths = {
   runnerOpenApi: 'spec/runner.openapi.json',
   runnerProtocol: 'spec/runner-protocol.md',
@@ -107,6 +170,8 @@ export const ciSpecAssetPaths = {
   versionCases: 'conformance/version-cases.json',
   compileCases: 'conformance/compile-cases.json',
   compileCasesSchema: 'conformance/compile-cases.schema.json',
+  runnerJobCases: 'conformance/runner-job-cases.json',
+  runnerJobCasesSchema: 'conformance/runner-job-cases.schema.json',
   ciActionsConformanceDirectory: 'conformance/ci-actions',
   runnerJobConformanceDirectory: 'conformance/runner-jobs',
 } as const;