@ship.zone/ci-spec 2.0.0

package/ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@ship.zone/ci-spec',
+  version: '2.0.0',
+  description: 'The ship.zone CI standard: language-neutral CI workflow and runner protocol specifications.'
+}

package/ts/constants.ts

@@ -0,0 +1,112 @@
+import { commitinfo } from './00_commitinfo_data.js';
+
+/**
+ * The specification version: the published `@ship.zone/ci-spec` package version. It is the
+ * version an implementation built against this package implements, and the only version a
+ * workflow, compiled job, or runner protocol message carries (as `spec`).
+ */
+export const ciSpecVersion: string = commitinfo.version;
+export const ciSpecStatus = 'draft' as const;
+export const runnerProtocolBasePath = '/api/runner' as const;
+export const maximumArchivePathMetadataBytes = 134_217_728 as const;
+
+/**
+ * Execution profile identifiers. The normative schemas define each identifier once
+ * (`containerProfile`, `imageBuildProfile`, and `vmProfile`); the conformance tests assert both
+ * sources agree.
+ */
+export const executionProfileIdentifiers = {
+  container: 'oci',
+  imageBuild: 'oci-image',
+  virtualMachine: 'vm',
+} as const;
+
+/**
+ * Runner feature identifiers, mirrored from the runner job schema `feature` definition.
+ */
+export const runnerFeatureIdentifiers = ['source.tar-gz', 'artifacts', 'caches'] as const;
+
+/**
+ * Lease feature identifiers a runner may advertise in `RunnerCapabilities.leaseFeatures`, mirrored
+ * from the OpenAPI `LeaseFeature` component.
+ */
+export const leaseFeatureIdentifiers = ['image-pull-grants', 'candidate-bindings', 'npm-read-grants'] as const;
+
+/**
+ * The layers of `ci_actions.yml` compilation, in evaluation order (spec/ci-actions.md, Compilation
+ * Failures).
+ */
+export const compilationFailureLayers = ['source', 'yaml', 'version', 'schema', 'workflow', 'policy', 'run'] as const;
+
+/**
+ * Every compilation failure code with its layer, in precedence order, mirrored from
+ * `conformance/compile-cases.json` `failureCodes`; the conformance tests assert both sources and the
+ * prose table agree.
+ */
+export const compilationFailureCodes = [
+  { code: 'workflow_too_large', layer: 'source' },
+  { code: 'workflow_encoding_invalid', layer: 'source' },
+  { code: 'workflow_yaml_syntax', layer: 'yaml' },
+  { code: 'workflow_yaml_document_count', layer: 'yaml' },
+  { code: 'workflow_yaml_directive', layer: 'yaml' },
+  { code: 'workflow_yaml_duplicate_key', layer: 'yaml' },
+  { code: 'workflow_yaml_key_type', layer: 'yaml' },
+  { code: 'workflow_yaml_anchor', layer: 'yaml' },
+  { code: 'workflow_yaml_merge_key', layer: 'yaml' },
+  { code: 'workflow_yaml_tag', layer: 'yaml' },
+  { code: 'workflow_number_invalid', layer: 'yaml' },
+  { code: 'spec_incompatible', layer: 'version' },
+  { code: 'workflow_schema_invalid', layer: 'schema' },
+  { code: 'trigger_pattern_invalid', layer: 'workflow' },
+  { code: 'needs_unknown', layer: 'workflow' },
+  { code: 'needs_cycle', layer: 'workflow' },
+  { code: 'expansion_limit_exceeded', layer: 'workflow' },
+  { code: 'needs_trigger_wider', layer: 'workflow' },
+  { code: 'trigger_kind_unused', layer: 'workflow' },
+  { code: 'permission_escalation', layer: 'workflow' },
+  { code: 'permission_insufficient', layer: 'workflow' },
+  { code: 'environment_conflict', layer: 'workflow' },
+  { code: 'environment_limit_exceeded', layer: 'workflow' },
+  { code: 'command_limit_exceeded', layer: 'workflow' },
+  { code: 'transfer_name_duplicate', layer: 'workflow' },
+  { code: 'cache_path_overlap', layer: 'workflow' },
+  { code: 'resources_invalid', layer: 'workflow' },
+  { code: 'network_host_duplicate', layer: 'workflow' },
+  { code: 'npm_read_invalid', layer: 'workflow' },
+  { code: 'build_input_conflict', layer: 'workflow' },
+  { code: 'candidate_reference_invalid', layer: 'workflow' },
+  { code: 'candidate_platform_missing', layer: 'workflow' },
+  { code: 'publish_reference_invalid', layer: 'workflow' },
+  { code: 'policy_limit_exceeded', layer: 'policy' },
+  { code: 'policy_timeout_exceeded', layer: 'policy' },
+  { code: 'policy_retention_exceeded', layer: 'policy' },
+  { code: 'policy_egress_denied', layer: 'policy' },
+  { code: 'policy_npm_registry_denied', layer: 'policy' },
+  { code: 'policy_denied', layer: 'policy' },
+  { code: 'manual_input_invalid', layer: 'run' },
+  { code: 'tag_version_required', layer: 'run' },
+  { code: 'alias_invalid', layer: 'run' },
+  { code: 'alias_duplicate', layer: 'run' },
+  { code: 'secret_untrusted', layer: 'run' },
+  { code: 'npm_read_untrusted', layer: 'run' },
+  { code: 'secret_unknown', layer: 'run' },
+  { code: 'protected_secret_denied', layer: 'run' },
+  { code: 'secret_too_short', layer: 'run' },
+] as const;
+
+export const ciSpecAssetPaths = {
+  runnerOpenApi: 'spec/runner.openapi.json',
+  runnerProtocol: 'spec/runner-protocol.md',
+  ciActionsProtocol: 'spec/ci-actions.md',
+  runnerJobSchema: 'schemas/runner-job.schema.json',
+  ciActionsSchema: 'schemas/ci_actions.schema.json',
+  runnerConformanceCases: 'conformance/runner-cases.json',
+  runnerMessageCases: 'conformance/runner-messages.json',
+  digestCases: 'conformance/digest-cases.json',
+  archiveCases: 'conformance/archive-cases.json',
+  versionCases: 'conformance/version-cases.json',
+  compileCases: 'conformance/compile-cases.json',
+  compileCasesSchema: 'conformance/compile-cases.schema.json',
+  ciActionsConformanceDirectory: 'conformance/ci-actions',
+  runnerJobConformanceDirectory: 'conformance/runner-jobs',
+} as const;

package/ts/index.ts

@@ -0,0 +1 @@
+export * from './constants.js';

package/ts/plugins.ts

@@ -0,0 +1 @@
+// This package intentionally has no runtime dependencies.