@moonrepo/types 1.33.2 → 2.0.0

package/src/workspace-config.ts

@@ -3,46 +3,39 @@
 /* eslint-disable */
 
 import type { ExtendsFrom, Id } from './common';
-import type { PluginLocator } from './toolchain-config';
 
 /** How to order ownership rules within the generated file. */
-export type CodeownersOrderBy = 'file-source' | 'project-name';
+export type CodeownersOrderBy = 'file-source' | 'project-id';
 
 /** Configures code ownership rules for generating a `CODEOWNERS` file. */
 export interface CodeownersConfig {
 	/**
-	 * Paths that are applied globally to all projects. Can be relative
-	 * from the workspace root, or a wildcard match for any depth.
+	 * A map of global file paths and glob patterns to a list of owners.
+	 * Can be relative from the workspace root, or a wildcard match for any depth.
 	 */
 	globalPaths: Record<string, string[]>;
 	/**
 	 * How to order ownership rules within the generated file.
 	 *
 	 * @default 'file-source'
-	 * @type {'file-source' | 'project-name'}
+	 * @type {'file-source' | 'project-id'}
 	 */
 	orderBy: CodeownersOrderBy;
 	/**
 	 * Bitbucket and GitLab only. The number of approvals required for the
 	 * request to be satisfied. This will be applied to all paths.
+	 * @since 1.28.0
 	 */
 	requiredApprovals: number | null;
 	/**
-	 * Generates a `CODEOWNERS` file after aggregating all ownership
-	 * rules from each project in the workspace.
+	 * Automatically generate a `CODEOWNERS` file during a sync operation,
+	 * after aggregating all ownership rules from each project in the workspace.
 	 */
-	syncOnRun: boolean;
+	sync: boolean;
 }
 
 /** Configures boundaries and constraints between projects. */
 export interface ConstraintsConfig {
-	/**
-	 * Enforces relationships between projects based on each project's
-	 * `layer` setting.
-	 *
-	 * @default true
-	 */
-	enforceProjectTypeRelationships?: boolean;
 	/**
 	 * Enforces relationships between projects based on each project's
 	 * `layer` setting.
@@ -57,11 +50,52 @@ export interface ConstraintsConfig {
 	tagRelationships: Record<Id, Id[]>;
 }
 
+/**
+ * Configures `Dockerfile` generation. When configured at the workspace-level,
+ * applies to all projects, but can be overridden at the project-level.
+ */
+export interface DockerFileConfig {
+	/**
+	 * A task identifier within the current project for building the project.
+	 * If not defined, will skip the build step.
+	 */
+	buildTask: Id | null;
+	/**
+	 * The base Docker image to use. If not defined, will use the provided image
+	 * from the first matching toolchain, otherwise defaults to "scratch".
+	 */
+	image: string | null;
+	/**
+	 * Run the `moon docker prune` command after building the
+	 * project, but before starting it.
+	 * @since 2.0.0
+	 */
+	runPrune: boolean | null;
+	/**
+	 * Run the `moon docker setup` command after scaffolding,
+	 * but before building the project.
+	 * @since 2.0.0
+	 */
+	runSetup: boolean | null;
+	/**
+	 * A task identifier within the current project for starting the project
+	 * within the `CMD` instruction. If not defined, will skip the start step
+	 * and not include the `CMD` instruction.
+	 */
+	startTask: Id | null;
+	/**
+	 * A custom template file, relative from the workspace root, to use when
+	 * rendering the `Dockerfile`. Powered by Tera.
+	 */
+	template: string | null;
+}
+
 /** Configures aspects of the Docker pruning process. */
 export interface DockerPruneConfig {
 	/**
 	 * Automatically delete vendor directories (package manager
-	 * dependencies, build targets, etc) while pruning.
+	 * dependencies, build targets, etc) while pruning. This is
+	 * handled by each toolchain plugin and not moon directly.
 	 *
 	 * @default true
 	 */
@@ -72,27 +106,36 @@ export interface DockerPruneConfig {
 	 *
 	 * @default true
 	 */
-	installToolchainDeps?: boolean;
+	installToolchainDependencies?: boolean;
 }
 
-/** Configures aspects of the Docker scaffolding process. */
+/**
+ * Configures aspects of the Docker scaffolding process.
+ * When configured at the workspace-level, applies to all projects,
+ * but can be overridden at the project-level.
+ */
 export interface DockerScaffoldConfig {
 	/**
-	 * Copy toolchain specific configs/manifests/files into
-	 * the workspace skeleton.
-	 *
-	 * @default true
+	 * List of glob patterns in which to include/exclude files in
+	 * the "configs" skeleton. Applies to both project and
+	 * workspace level scaffolding.
 	 */
-	copyToolchainFiles?: boolean;
+	configsPhaseGlobs: string[];
 	/**
-	 * List of glob patterns, relative from the workspace root,
-	 * to include (or exclude) in the workspace skeleton.
+	 * List of glob patterns in which to include/exclude files in
+	 * the "sources" skeleton. Applies to both project and
+	 * workspace level scaffolding.
 	 */
-	include: string[];
+	sourcesPhaseGlobs: string[];
 }
 
 /** Configures our Docker integration. */
 export interface DockerConfig {
+	/**
+	 * Configures aspects of the `Dockerfile` generation process.
+	 * @since 2.0.0
+	 */
+	file: DockerFileConfig;
 	/** Configures aspects of the Docker pruning process. */
 	prune: DockerPruneConfig;
 	/** Configures aspects of the Docker scaffolding process. */
@@ -100,59 +143,7 @@ export interface DockerConfig {
 }
 
 /** Configures experiments across the entire moon workspace. */
-export interface ExperimentsConfig {
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	actionPipelineV2?: boolean;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	disallowRunInCiMismatch?: boolean;
-	/**
-	 * Enable faster glob file system walking.
-	 *
-	 * @default true
-	 */
-	fasterGlobWalk?: boolean;
-	/**
-	 * Enable a faster and more accurate Git implementation.
-	 * Supports submodules, subtrees, and worktrees.
-	 *
-	 * @default true
-	 */
-	gitV2?: boolean;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	interweavedTaskInheritance?: boolean;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	strictProjectAliases?: boolean;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	strictProjectIds?: boolean;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	taskOutputBoundaries?: boolean;
-}
-
-/** Configures an individual extension. */
-export interface ExtensionConfig {
-	/** Arbitrary configuration that'll be passed to the WASM plugin. */
-	config: Record<string, unknown>;
-	/** Location of the WASM plugin to use. */
-	plugin: PluginLocator | null;
-}
+export interface ExperimentsConfig {}
 
 /** Configures the generator for scaffolding from templates. */
 export interface GeneratorConfig {
@@ -171,22 +162,17 @@ export type HasherWalkStrategy = 'glob' | 'vcs';
 
 /** Configures aspects of the content hashing engine. */
 export interface HasherConfig {
-	/**
-	 * The number of files to include in each hash operation.
-	 *
-	 * @default 2500
-	 * @deprecated
-	 */
-	batchSize?: number;
 	/**
 	 * When `warnOnMissingInputs` is enabled, filters missing file
 	 * paths from logging a warning.
+	 * @since 1.10.0
 	 */
 	ignoreMissingPatterns: string[];
 	/**
 	 * Filters file paths that match a configured glob pattern
 	 * when a hash is being generated. Patterns are workspace relative,
 	 * so prefixing with `**` is recommended.
+	 * @since 1.10.0
 	 */
 	ignorePatterns: string[];
 	/**
@@ -218,34 +204,28 @@ export type NotifierEventType = 'never' | 'always' | 'failure' | 'success' | 'ta
 /** Configures how and where notifications are sent. */
 export interface NotifierConfig {
 	/**
-	 * Display an OS notification for certain pipeline events.
+	 * Display an OS notification for certain action pipeline events.
+	 * @since 1.38.0
 	 *
 	 * @default 'never'
 	 */
 	terminalNotifications: NotifierEventType | null;
 	/**
 	 * Whether webhook requests require acknowledgment (2xx response).
-	 *
-	 * @default false
+	 * @since 1.38.0
 	 */
-	webhookAcknowledge?: boolean;
+	webhookAcknowledge: boolean;
 	/** A secure URL in which to send webhooks to. */
 	webhookUrl: string | null;
 }
 
 export type PipelineActionSwitch = null | boolean | Id[];
 
-/** Configures aspects of the task runner (also known as the action pipeline). */
+/** Configures aspects of the action pipeline. */
 export interface PipelineConfig {
-	/**
-	 * List of target's for tasks without outputs, that should be
-	 * cached and persisted.
-	 *
-	 * @deprecated
-	 */
-	archivableTargets: string[];
 	/**
 	 * Automatically clean the cache after every task run.
+	 * @since 1.24.0
 	 *
 	 * @default true
 	 */
@@ -263,12 +243,13 @@ export interface PipelineConfig {
 	 */
 	inheritColorsForPipedTasks?: boolean;
 	/**
-	 * Run the `InstallWorkspaceDeps` and `InstallProjectDeps` actions for
-	 * each running task when changes to lockfiles and manifests are detected.
+	 * Run the `InstallDependencies` actions for each running task
+	 * when changes to lockfiles and manifests are detected.
+	 * @since 1.34.0
 	 */
 	installDependencies: PipelineActionSwitch;
 	/**
-	 * Threshold in milliseconds in which to force kill running child
+	 * A threshold in milliseconds in which to force kill running child
 	 * processes after the pipeline receives an external signal. A value
 	 * of 0 will not kill the process and let them run to completion.
 	 *
@@ -280,6 +261,7 @@ export interface PipelineConfig {
 	/**
 	 * When creating `SyncProject` actions, recursively create a `SyncProject`
 	 * action for each project dependency, and link them as a relationship.
+	 * @since 1.34.0
 	 *
 	 * @default true
 	 */
@@ -287,54 +269,80 @@ export interface PipelineConfig {
 	/**
 	 * Run the `SyncProject` actions in the pipeline for each owning project
 	 * of a running task.
+	 * @since 1.34.0
 	 */
 	syncProjects: PipelineActionSwitch;
 	/**
 	 * Run the `SyncWorkspace` action before all actions in the pipeline.
+	 * @since 1.34.0
 	 *
 	 * @default true
 	 */
 	syncWorkspace?: boolean;
 }
 
+/** The project identifier format for glob located projects. */
+export type WorkspaceProjectGlobFormat = 'dir-name' | 'source-path';
+
 /** Configures projects in the workspace, using both globs and explicit source paths. */
 export interface WorkspaceProjectsConfig {
 	/**
-	 * A list of globs in which to locate project directories.
-	 * Can be suffixed with `moon.yml` or `moon.pkl` to only find distinct projects.
+	 * The project identifier format for glob located projects.
+	 * @since 2.0.0
+	 *
+	 * @default 'dir-name'
+	 * @type {'dir-name' | 'source-path'}
+	 */
+	globFormat: WorkspaceProjectGlobFormat;
+	/**
+	 * A list of glob patterns in which to locate project directories.
+	 * Can be suffixed with a `moon.*` config file to only find distinct projects.
 	 */
 	globs: string[];
-	/** A mapping of project IDs to relative file paths to each project directory. */
+	/** A map of project identifiers to relative file paths to each project directory. */
 	sources: Record<Id, string>;
 }
 
 export type WorkspaceProjects = WorkspaceProjectsConfig | string[] | Record<Id, string>;
 
-/** The API format of the remote service. */
+/**
+ * The API format of the remote service.
+ * @since 1.32.0
+ */
 export type RemoteApi = 'grpc' | 'http';
 
-/** Configures basic HTTP authentication. */
+/**
+ * Configures basic HTTP authentication.
+ * @since 1.32.0
+ */
 export interface RemoteAuthConfig {
-	/** HTTP headers to inject into every request. */
+	/** A map of HTTP headers to inject into every request. */
 	headers: Record<string, string>;
 	/**
 	 * The name of an environment variable to use as a bearer token.
 	 *
-	 * @envvar MOON_REMOTE_AUTH_TOKEN
+	 * @env MOON_REMOTE_AUTH_TOKEN
 	 */
 	token: string | null;
 }
 
-/** Supported blob compression levels for gRPC APIs. */
+/**
+ * Supported blob compression levels for gRPC APIs.
+ * @since 1.31.0
+ */
 export type RemoteCompression = 'none' | 'zstd';
 
-/** Configures the action cache (AC) and content addressable cache (CAS). */
+/**
+ * Configures the action cache (AC) and content addressable cache (CAS).
+ * @since 1.30.0
+ */
 export interface RemoteCacheConfig {
 	/**
 	 * The compression format to use when uploading/downloading blobs.
+	 * @since 1.31.0
 	 *
 	 * @default 'none'
-	 * @envvar MOON_REMOTE_CACHE_COMPRESSION
+	 * @env MOON_REMOTE_CACHE_COMPRESSION
 	 * @type {'none' | 'zstd'}
 	 */
 	compression: RemoteCompression;
@@ -342,99 +350,114 @@ export interface RemoteCacheConfig {
 	 * Unique instance name for blobs. Will be used as a folder name.
 	 *
 	 * @default 'moon-outputs'
-	 * @envvar MOON_REMOTE_CACHE_INSTANCE_NAME
+	 * @env MOON_REMOTE_CACHE_INSTANCE_NAME
 	 */
 	instanceName?: string;
 	/**
 	 * When local, only download matching blobs and do not upload new
 	 * blobs. Blobs will only be uploaded in CI environments.
+	 * @since 1.40.0
 	 *
-	 * @envvar MOON_REMOTE_CACHE_LOCAL_READ_ONLY
+	 * @env MOON_REMOTE_CACHE_LOCAL_READ_ONLY
 	 */
 	localReadOnly: boolean;
 	/**
 	 * When downloading blobs, verify the digests/hashes in the response
 	 * match the associated blob contents. This will reduce performance
 	 * but ensure partial or corrupted blobs won't cause failures.
+	 * @since 1.36.0
 	 *
-	 * @envvar MOON_REMOTE_CACHE_VERIFY_INTEGRITY
+	 * @env MOON_REMOTE_CACHE_VERIFY_INTEGRITY
 	 */
 	verifyIntegrity: boolean;
 }
 
-/** Configures for both server and client authentication with mTLS. */
+/**
+ * Configures for both server and client authentication with mTLS.
+ * @since 1.30.0
+ */
 export interface RemoteMtlsConfig {
 	/**
 	 * If true, assume that the server supports HTTP/2,
 	 * even if it doesn't provide protocol negotiation via ALPN.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_HTTP
+	 * @env MOON_REMOTE_MTLS_HTTP
 	 */
 	assumeHttp2: boolean;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * certificate authority PEM encoded X509 certificate.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_CA_CERT
+	 * @env MOON_REMOTE_MTLS_CA_CERT
 	 */
 	caCert: string;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * client's PEM encoded X509 certificate.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_CLIENT_CERT
+	 * @env MOON_REMOTE_MTLS_CLIENT_CERT
 	 */
 	clientCert: string;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * client's PEM encoded X509 private key.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_CLIENT_KEY
+	 * @env MOON_REMOTE_MTLS_CLIENT_KEY
 	 */
 	clientKey: string;
 	/**
 	 * The domain name in which to verify the TLS certificate.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_DOMAIN
+	 * @env MOON_REMOTE_MTLS_DOMAIN
 	 */
 	domain: string | null;
 }
 
-/** Configures for server-only authentication with TLS. */
+/**
+ * Configures for server-only authentication with TLS.
+ * @since 1.30.0
+ */
 export interface RemoteTlsConfig {
 	/**
 	 * If true, assume that the server supports HTTP/2,
 	 * even if it doesn't provide protocol negotiation via ALPN.
 	 *
-	 * @envvar MOON_REMOTE_TLS_HTTP2
+	 * @env MOON_REMOTE_TLS_HTTP2
 	 */
 	assumeHttp2: boolean;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * certificate authority PEM encoded X509 certificate.
 	 *
-	 * @envvar MOON_REMOTE_TLS_CERT
+	 * @env MOON_REMOTE_TLS_CERT
 	 */
 	cert: string;
 	/**
 	 * The domain name in which to verify the TLS certificate.
 	 *
-	 * @envvar MOON_REMOTE_TLS_DOMAIN
+	 * @env MOON_REMOTE_TLS_DOMAIN
 	 */
 	domain: string | null;
 }
 
-/** Configures the remote service, powered by the Bazel Remote Execution API. */
+/**
+ * Configures the remote service, powered by the Bazel Remote Execution API.
+ * @since 1.30.0
+ */
 export interface RemoteConfig {
 	/**
 	 * The API format of the remote service.
+	 * @since 1.32.0
 	 *
 	 * @default 'grpc'
-	 * @envvar MOON_REMOTE_API
+	 * @env MOON_REMOTE_API
 	 * @type {'grpc' | 'http'}
 	 */
 	api: RemoteApi;
-	/** Connect to the host using basic HTTP authentication. */
+	/**
+	 * Connect to the host using basic HTTP authentication.
+	 * @since 1.32.0
+	 */
 	auth: RemoteAuthConfig | null;
 	/** Configures the action cache (AC) and content addressable cache (CAS). */
 	cache: RemoteCacheConfig;
@@ -442,7 +465,7 @@ export interface RemoteConfig {
 	 * The remote host to connect and send requests to.
 	 * Supports gRPC protocols.
 	 *
-	 * @envvar MOON_REMOTE_HOST
+	 * @env MOON_REMOTE_HOST
 	 */
 	host: string | null;
 	/**
@@ -454,11 +477,14 @@ export interface RemoteConfig {
 	tls: RemoteTlsConfig | null;
 }
 
-/** The format to use for generated VCS hook files. */
-export type VcsHookFormat = 'bash' | 'native';
-
 /** The VCS being utilized by the repository. */
-export type VcsManager = 'git';
+export type VcsClient = 'git';
+
+/**
+ * The format to use for generated VCS hook files.
+ * @since 1.29.0
+ */
+export type VcsHookFormat = 'bash' | 'native';
 
 /**
  * The upstream version control provider, where the repository
@@ -468,6 +494,13 @@ export type VcsProvider = 'bitbucket' | 'github' | 'gitlab' | 'other';
 
 /** Configures the version control system (VCS). */
 export interface VcsConfig {
+	/**
+	 * The VCS client being utilized by the repository.
+	 *
+	 * @default 'git'
+	 * @type {'git'}
+	 */
+	client: VcsClient;
 	/**
 	 * The default branch / base.
 	 *
@@ -476,23 +509,21 @@ export interface VcsConfig {
 	defaultBranch?: string;
 	/**
 	 * The format to use for generated VCS hook files.
+	 * @since 1.29.0
 	 *
 	 * @default 'native'
 	 * @type {'bash' | 'native'}
 	 */
 	hookFormat: VcsHookFormat;
-	/** A mapping of hooks to commands to run when the hook is triggered. */
-	hooks: Record<string, string[]>;
 	/**
-	 * The VCS client being utilized by the repository.
-	 *
-	 * @default 'git'
-	 * @type {'git'}
+	 * A map of hooks to a list of commands to run when the hook is triggered.
+	 * @since 1.9.0
 	 */
-	manager: VcsManager;
+	hooks: Record<string, string[]>;
 	/**
 	 * The upstream version control provider, where the repository
 	 * source code is stored.
+	 * @since 1.8.0
 	 *
 	 * @default 'github'
 	 * @type {'bitbucket' | 'github' | 'gitlab' | 'other'}
@@ -500,8 +531,12 @@ export interface VcsConfig {
 	provider: VcsProvider;
 	/** List of remote's in which to compare branches against. */
 	remoteCandidates?: string[];
-	/** Generates hooks and scripts based on the `hooks` setting. */
-	syncHooks: boolean;
+	/**
+	 * Automatically generate hooks and scripts during a sync operation,
+	 * based on the `hooks` setting.
+	 * @since 1.9.0
+	 */
+	sync: boolean;
 }
 
 /**
@@ -509,23 +544,37 @@ export interface VcsConfig {
  * Docs: https://moonrepo.dev/docs/config/workspace
  */
 export interface WorkspaceConfig {
-	/** @default 'https://moonrepo.dev/schemas/workspace.json' */
+	/** @default './cache/schemas/workspace.json' */
 	$schema?: string;
-	/** Configures code ownership rules for generating a `CODEOWNERS` file. */
+	/**
+	 * Configures code ownership rules for generating a `CODEOWNERS` file.
+	 * @since 1.8.0
+	 */
 	codeowners: CodeownersConfig;
 	/** Configures boundaries and constraints between projects. */
 	constraints: ConstraintsConfig;
-	/** Configures Docker integration for the workspace. */
+	/**
+	 * The default/main project within the workspace. When a task is
+	 * ran without a project, the default will be used.
+	 * @since 2.0.0
+	 */
+	defaultProject: Id | null;
+	/**
+	 * Configures Docker integration for the workspace.
+	 * @since 1.27.0
+	 */
 	docker: DockerConfig;
-	/** Configures experiments across the entire moon workspace. */
+	/**
+	 * Configures experiments across the entire moon workspace.
+	 * @since 1.11.0
+	 */
 	experiments: ExperimentsConfig;
 	/**
-	 * Extends one or many workspace configuration file. Supports a relative
-	 * file path or a secure URL.
+	 * Extends one or many workspace configuration file.
+	 * Supports a relative file path or a secure URL.
+	 * @since 1.12.0
 	 */
 	extends: ExtendsFrom | null;
-	/** Configures extensions that can be executed with `moon ext`. */
-	extensions: Record<Id, ExtensionConfig>;
 	/** Configures the generator for scaffolding from templates. */
 	generator: GeneratorConfig;
 	/** Configures aspects of the content hashing engine. */
@@ -533,8 +582,6 @@ export interface WorkspaceConfig {
 	/** Configures how and where notifications are sent. */
 	notifier: NotifierConfig;
 	/** Configures aspects of the action pipeline. */
-	runner?: PipelineConfig;
-	/** Configures aspects of the action pipeline. */
 	pipeline: PipelineConfig;
 	/**
 	 * Configures all projects within the workspace to create a project graph.
@@ -542,15 +589,19 @@ export interface WorkspaceConfig {
 	 * or both values.
 	 */
 	projects: WorkspaceProjects;
+	/** Configures aspects of the remote service. */
+	remote: RemoteConfig;
 	/**
 	 * Collects anonymous usage information, and checks for new moon versions.
 	 *
 	 * @default true
+	 * @env MOON_TELEMETRY
 	 */
 	telemetry?: boolean;
-	/** Configures aspects of the remote service. */
-	unstable_remote: RemoteConfig;
-	/** Configures the version control system (VCS). */
+	/**
+	 * Configures the version control system (VCS). Also known as
+	 * source code management (SCM).
+	 */
 	vcs: VcsConfig;
 	/** Requires a specific version of the `moon` binary. */
 	versionConstraint: string | null;
@@ -559,8 +610,8 @@ export interface WorkspaceConfig {
 /** Configures code ownership rules for generating a `CODEOWNERS` file. */
 export interface PartialCodeownersConfig {
 	/**
-	 * Paths that are applied globally to all projects. Can be relative
-	 * from the workspace root, or a wildcard match for any depth.
+	 * A map of global file paths and glob patterns to a list of owners.
+	 * Can be relative from the workspace root, or a wildcard match for any depth.
 	 */
 	globalPaths?: Record<string, string[]> | null;
 	/**
@@ -572,24 +623,18 @@ export interface PartialCodeownersConfig {
 	/**
 	 * Bitbucket and GitLab only. The number of approvals required for the
 	 * request to be satisfied. This will be applied to all paths.
+	 * @since 1.28.0
 	 */
 	requiredApprovals?: number | null;
 	/**
-	 * Generates a `CODEOWNERS` file after aggregating all ownership
-	 * rules from each project in the workspace.
+	 * Automatically generate a `CODEOWNERS` file during a sync operation,
+	 * after aggregating all ownership rules from each project in the workspace.
 	 */
-	syncOnRun?: boolean | null;
+	sync?: boolean | null;
 }
 
 /** Configures boundaries and constraints between projects. */
 export interface PartialConstraintsConfig {
-	/**
-	 * Enforces relationships between projects based on each project's
-	 * `layer` setting.
-	 *
-	 * @default true
-	 */
-	enforceProjectTypeRelationships?: boolean | null;
 	/**
 	 * Enforces relationships between projects based on each project's
 	 * `layer` setting.
@@ -604,11 +649,52 @@ export interface PartialConstraintsConfig {
 	tagRelationships?: Record<Id, Id[]> | null;
 }
 
+/**
+ * Configures `Dockerfile` generation. When configured at the workspace-level,
+ * applies to all projects, but can be overridden at the project-level.
+ */
+export interface PartialDockerFileConfig {
+	/**
+	 * A task identifier within the current project for building the project.
+	 * If not defined, will skip the build step.
+	 */
+	buildTask?: Id | null;
+	/**
+	 * The base Docker image to use. If not defined, will use the provided image
+	 * from the first matching toolchain, otherwise defaults to "scratch".
+	 */
+	image?: string | null;
+	/**
+	 * Run the `moon docker prune` command after building the
+	 * project, but before starting it.
+	 * @since 2.0.0
+	 */
+	runPrune?: boolean | null;
+	/**
+	 * Run the `moon docker setup` command after scaffolding,
+	 * but before building the project.
+	 * @since 2.0.0
+	 */
+	runSetup?: boolean | null;
+	/**
+	 * A task identifier within the current project for starting the project
+	 * within the `CMD` instruction. If not defined, will skip the start step
+	 * and not include the `CMD` instruction.
+	 */
+	startTask?: Id | null;
+	/**
+	 * A custom template file, relative from the workspace root, to use when
+	 * rendering the `Dockerfile`. Powered by Tera.
+	 */
+	template?: string | null;
+}
+
 /** Configures aspects of the Docker pruning process. */
 export interface PartialDockerPruneConfig {
 	/**
 	 * Automatically delete vendor directories (package manager
-	 * dependencies, build targets, etc) while pruning.
+	 * dependencies, build targets, etc) while pruning. This is
+	 * handled by each toolchain plugin and not moon directly.
 	 *
 	 * @default true
 	 */
@@ -619,27 +705,36 @@ export interface PartialDockerPruneConfig {
 	 *
 	 * @default true
 	 */
-	installToolchainDeps?: boolean | null;
+	installToolchainDependencies?: boolean | null;
 }
 
-/** Configures aspects of the Docker scaffolding process. */
+/**
+ * Configures aspects of the Docker scaffolding process.
+ * When configured at the workspace-level, applies to all projects,
+ * but can be overridden at the project-level.
+ */
 export interface PartialDockerScaffoldConfig {
 	/**
-	 * Copy toolchain specific configs/manifests/files into
-	 * the workspace skeleton.
-	 *
-	 * @default true
+	 * List of glob patterns in which to include/exclude files in
+	 * the "configs" skeleton. Applies to both project and
+	 * workspace level scaffolding.
 	 */
-	copyToolchainFiles?: boolean | null;
+	configsPhaseGlobs?: string[] | null;
 	/**
-	 * List of glob patterns, relative from the workspace root,
-	 * to include (or exclude) in the workspace skeleton.
+	 * List of glob patterns in which to include/exclude files in
+	 * the "sources" skeleton. Applies to both project and
+	 * workspace level scaffolding.
 	 */
-	include?: string[] | null;
+	sourcesPhaseGlobs?: string[] | null;
 }
 
 /** Configures our Docker integration. */
 export interface PartialDockerConfig {
+	/**
+	 * Configures aspects of the `Dockerfile` generation process.
+	 * @since 2.0.0
+	 */
+	file?: PartialDockerFileConfig | null;
 	/** Configures aspects of the Docker pruning process. */
 	prune?: PartialDockerPruneConfig | null;
 	/** Configures aspects of the Docker scaffolding process. */
@@ -647,59 +742,7 @@ export interface PartialDockerConfig {
 }
 
 /** Configures experiments across the entire moon workspace. */
-export interface PartialExperimentsConfig {
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	actionPipelineV2?: boolean | null;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	disallowRunInCiMismatch?: boolean | null;
-	/**
-	 * Enable faster glob file system walking.
-	 *
-	 * @default true
-	 */
-	fasterGlobWalk?: boolean | null;
-	/**
-	 * Enable a faster and more accurate Git implementation.
-	 * Supports submodules, subtrees, and worktrees.
-	 *
-	 * @default true
-	 */
-	gitV2?: boolean | null;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	interweavedTaskInheritance?: boolean | null;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	strictProjectAliases?: boolean | null;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	strictProjectIds?: boolean | null;
-	/**
-	 * @default true
-	 * @deprecated
-	 */
-	taskOutputBoundaries?: boolean | null;
-}
-
-/** Configures an individual extension. */
-export interface PartialExtensionConfig {
-	/** Arbitrary configuration that'll be passed to the WASM plugin. */
-	config?: Record<string, unknown> | null;
-	/** Location of the WASM plugin to use. */
-	plugin?: PluginLocator | null;
-}
+export interface PartialExperimentsConfig {}
 
 /** Configures the generator for scaffolding from templates. */
 export interface PartialGeneratorConfig {
@@ -712,22 +755,17 @@ export interface PartialGeneratorConfig {
 
 /** Configures aspects of the content hashing engine. */
 export interface PartialHasherConfig {
-	/**
-	 * The number of files to include in each hash operation.
-	 *
-	 * @default 2500
-	 * @deprecated
-	 */
-	batchSize?: number | null;
 	/**
 	 * When `warnOnMissingInputs` is enabled, filters missing file
 	 * paths from logging a warning.
+	 * @since 1.10.0
 	 */
 	ignoreMissingPatterns?: string[] | null;
 	/**
 	 * Filters file paths that match a configured glob pattern
 	 * when a hash is being generated. Patterns are workspace relative,
 	 * so prefixing with `**` is recommended.
+	 * @since 1.10.0
 	 */
 	ignorePatterns?: string[] | null;
 	/**
@@ -754,15 +792,15 @@ export interface PartialHasherConfig {
 /** Configures how and where notifications are sent. */
 export interface PartialNotifierConfig {
 	/**
-	 * Display an OS notification for certain pipeline events.
+	 * Display an OS notification for certain action pipeline events.
+	 * @since 1.38.0
 	 *
 	 * @default 'never'
 	 */
 	terminalNotifications?: NotifierEventType | null;
 	/**
 	 * Whether webhook requests require acknowledgment (2xx response).
-	 *
-	 * @default false
+	 * @since 1.38.0
 	 */
 	webhookAcknowledge?: boolean | null;
 	/** A secure URL in which to send webhooks to. */
@@ -771,17 +809,11 @@ export interface PartialNotifierConfig {
 
 export type PartialPipelineActionSwitch = null | boolean | Id[];
 
-/** Configures aspects of the task runner (also known as the action pipeline). */
+/** Configures aspects of the action pipeline. */
 export interface PartialPipelineConfig {
-	/**
-	 * List of target's for tasks without outputs, that should be
-	 * cached and persisted.
-	 *
-	 * @deprecated
-	 */
-	archivableTargets?: string[] | null;
 	/**
 	 * Automatically clean the cache after every task run.
+	 * @since 1.24.0
 	 *
 	 * @default true
 	 */
@@ -799,12 +831,13 @@ export interface PartialPipelineConfig {
 	 */
 	inheritColorsForPipedTasks?: boolean | null;
 	/**
-	 * Run the `InstallWorkspaceDeps` and `InstallProjectDeps` actions for
-	 * each running task when changes to lockfiles and manifests are detected.
+	 * Run the `InstallDependencies` actions for each running task
+	 * when changes to lockfiles and manifests are detected.
+	 * @since 1.34.0
 	 */
 	installDependencies?: PartialPipelineActionSwitch | null;
 	/**
-	 * Threshold in milliseconds in which to force kill running child
+	 * A threshold in milliseconds in which to force kill running child
 	 * processes after the pipeline receives an external signal. A value
 	 * of 0 will not kill the process and let them run to completion.
 	 *
@@ -816,6 +849,7 @@ export interface PartialPipelineConfig {
 	/**
 	 * When creating `SyncProject` actions, recursively create a `SyncProject`
 	 * action for each project dependency, and link them as a relationship.
+	 * @since 1.34.0
 	 *
 	 * @default true
 	 */
@@ -823,10 +857,12 @@ export interface PartialPipelineConfig {
 	/**
 	 * Run the `SyncProject` actions in the pipeline for each owning project
 	 * of a running task.
+	 * @since 1.34.0
 	 */
 	syncProjects?: PartialPipelineActionSwitch | null;
 	/**
 	 * Run the `SyncWorkspace` action before all actions in the pipeline.
+	 * @since 1.34.0
 	 *
 	 * @default true
 	 */
@@ -836,11 +872,18 @@ export interface PartialPipelineConfig {
 /** Configures projects in the workspace, using both globs and explicit source paths. */
 export interface PartialWorkspaceProjectsConfig {
 	/**
-	 * A list of globs in which to locate project directories.
-	 * Can be suffixed with `moon.yml` or `moon.pkl` to only find distinct projects.
+	 * The project identifier format for glob located projects.
+	 * @since 2.0.0
+	 *
+	 * @default 'dir-name'
+	 */
+	globFormat?: WorkspaceProjectGlobFormat | null;
+	/**
+	 * A list of glob patterns in which to locate project directories.
+	 * Can be suffixed with a `moon.*` config file to only find distinct projects.
 	 */
 	globs?: string[] | null;
-	/** A mapping of project IDs to relative file paths to each project directory. */
+	/** A map of project identifiers to relative file paths to each project directory. */
 	sources?: Record<Id, string> | null;
 }
 
@@ -849,123 +892,145 @@ export type PartialWorkspaceProjects =
 	| string[]
 	| Record<Id, string>;
 
-/** Configures basic HTTP authentication. */
+/**
+ * Configures basic HTTP authentication.
+ * @since 1.32.0
+ */
 export interface PartialRemoteAuthConfig {
-	/** HTTP headers to inject into every request. */
+	/** A map of HTTP headers to inject into every request. */
 	headers?: Record<string, string> | null;
 	/**
 	 * The name of an environment variable to use as a bearer token.
 	 *
-	 * @envvar MOON_REMOTE_AUTH_TOKEN
+	 * @env MOON_REMOTE_AUTH_TOKEN
 	 */
 	token?: string | null;
 }
 
-/** Configures the action cache (AC) and content addressable cache (CAS). */
+/**
+ * Configures the action cache (AC) and content addressable cache (CAS).
+ * @since 1.30.0
+ */
 export interface PartialRemoteCacheConfig {
 	/**
 	 * The compression format to use when uploading/downloading blobs.
+	 * @since 1.31.0
 	 *
 	 * @default 'none'
-	 * @envvar MOON_REMOTE_CACHE_COMPRESSION
+	 * @env MOON_REMOTE_CACHE_COMPRESSION
 	 */
 	compression?: RemoteCompression | null;
 	/**
 	 * Unique instance name for blobs. Will be used as a folder name.
 	 *
 	 * @default 'moon-outputs'
-	 * @envvar MOON_REMOTE_CACHE_INSTANCE_NAME
+	 * @env MOON_REMOTE_CACHE_INSTANCE_NAME
 	 */
 	instanceName?: string | null;
 	/**
 	 * When local, only download matching blobs and do not upload new
 	 * blobs. Blobs will only be uploaded in CI environments.
+	 * @since 1.40.0
 	 *
-	 * @envvar MOON_REMOTE_CACHE_LOCAL_READ_ONLY
+	 * @env MOON_REMOTE_CACHE_LOCAL_READ_ONLY
 	 */
 	localReadOnly?: boolean | null;
 	/**
 	 * When downloading blobs, verify the digests/hashes in the response
 	 * match the associated blob contents. This will reduce performance
 	 * but ensure partial or corrupted blobs won't cause failures.
+	 * @since 1.36.0
 	 *
-	 * @envvar MOON_REMOTE_CACHE_VERIFY_INTEGRITY
+	 * @env MOON_REMOTE_CACHE_VERIFY_INTEGRITY
 	 */
 	verifyIntegrity?: boolean | null;
 }
 
-/** Configures for both server and client authentication with mTLS. */
+/**
+ * Configures for both server and client authentication with mTLS.
+ * @since 1.30.0
+ */
 export interface PartialRemoteMtlsConfig {
 	/**
 	 * If true, assume that the server supports HTTP/2,
 	 * even if it doesn't provide protocol negotiation via ALPN.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_HTTP
+	 * @env MOON_REMOTE_MTLS_HTTP
 	 */
 	assumeHttp2?: boolean | null;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * certificate authority PEM encoded X509 certificate.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_CA_CERT
+	 * @env MOON_REMOTE_MTLS_CA_CERT
 	 */
 	caCert?: string | null;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * client's PEM encoded X509 certificate.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_CLIENT_CERT
+	 * @env MOON_REMOTE_MTLS_CLIENT_CERT
 	 */
 	clientCert?: string | null;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * client's PEM encoded X509 private key.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_CLIENT_KEY
+	 * @env MOON_REMOTE_MTLS_CLIENT_KEY
 	 */
 	clientKey?: string | null;
 	/**
 	 * The domain name in which to verify the TLS certificate.
 	 *
-	 * @envvar MOON_REMOTE_MTLS_DOMAIN
+	 * @env MOON_REMOTE_MTLS_DOMAIN
 	 */
 	domain?: string | null;
 }
 
-/** Configures for server-only authentication with TLS. */
+/**
+ * Configures for server-only authentication with TLS.
+ * @since 1.30.0
+ */
 export interface PartialRemoteTlsConfig {
 	/**
 	 * If true, assume that the server supports HTTP/2,
 	 * even if it doesn't provide protocol negotiation via ALPN.
 	 *
-	 * @envvar MOON_REMOTE_TLS_HTTP2
+	 * @env MOON_REMOTE_TLS_HTTP2
 	 */
 	assumeHttp2?: boolean | null;
 	/**
 	 * A file path, relative from the workspace root, to the
 	 * certificate authority PEM encoded X509 certificate.
 	 *
-	 * @envvar MOON_REMOTE_TLS_CERT
+	 * @env MOON_REMOTE_TLS_CERT
 	 */
 	cert?: string | null;
 	/**
 	 * The domain name in which to verify the TLS certificate.
 	 *
-	 * @envvar MOON_REMOTE_TLS_DOMAIN
+	 * @env MOON_REMOTE_TLS_DOMAIN
 	 */
 	domain?: string | null;
 }
 
-/** Configures the remote service, powered by the Bazel Remote Execution API. */
+/**
+ * Configures the remote service, powered by the Bazel Remote Execution API.
+ * @since 1.30.0
+ */
 export interface PartialRemoteConfig {
 	/**
 	 * The API format of the remote service.
+	 * @since 1.32.0
 	 *
 	 * @default 'grpc'
-	 * @envvar MOON_REMOTE_API
+	 * @env MOON_REMOTE_API
 	 */
 	api?: RemoteApi | null;
-	/** Connect to the host using basic HTTP authentication. */
+	/**
+	 * Connect to the host using basic HTTP authentication.
+	 * @since 1.32.0
+	 */
 	auth?: PartialRemoteAuthConfig | null;
 	/** Configures the action cache (AC) and content addressable cache (CAS). */
 	cache?: PartialRemoteCacheConfig | null;
@@ -973,7 +1038,7 @@ export interface PartialRemoteConfig {
 	 * The remote host to connect and send requests to.
 	 * Supports gRPC protocols.
 	 *
-	 * @envvar MOON_REMOTE_HOST
+	 * @env MOON_REMOTE_HOST
 	 */
 	host?: string | null;
 	/**
@@ -987,6 +1052,12 @@ export interface PartialRemoteConfig {
 
 /** Configures the version control system (VCS). */
 export interface PartialVcsConfig {
+	/**
+	 * The VCS client being utilized by the repository.
+	 *
+	 * @default 'git'
+	 */
+	client?: VcsClient | null;
 	/**
 	 * The default branch / base.
 	 *
@@ -995,29 +1066,32 @@ export interface PartialVcsConfig {
 	defaultBranch?: string | null;
 	/**
 	 * The format to use for generated VCS hook files.
+	 * @since 1.29.0
 	 *
 	 * @default 'native'
 	 */
 	hookFormat?: VcsHookFormat | null;
-	/** A mapping of hooks to commands to run when the hook is triggered. */
-	hooks?: Record<string, string[]> | null;
 	/**
-	 * The VCS client being utilized by the repository.
-	 *
-	 * @default 'git'
+	 * A map of hooks to a list of commands to run when the hook is triggered.
+	 * @since 1.9.0
 	 */
-	manager?: VcsManager | null;
+	hooks?: Record<string, string[]> | null;
 	/**
 	 * The upstream version control provider, where the repository
 	 * source code is stored.
+	 * @since 1.8.0
 	 *
 	 * @default 'github'
 	 */
 	provider?: VcsProvider | null;
 	/** List of remote's in which to compare branches against. */
 	remoteCandidates?: string[] | null;
-	/** Generates hooks and scripts based on the `hooks` setting. */
-	syncHooks?: boolean | null;
+	/**
+	 * Automatically generate hooks and scripts during a sync operation,
+	 * based on the `hooks` setting.
+	 * @since 1.9.0
+	 */
+	sync?: boolean | null;
 }
 
 /**
@@ -1025,23 +1099,37 @@ export interface PartialVcsConfig {
  * Docs: https://moonrepo.dev/docs/config/workspace
  */
 export interface PartialWorkspaceConfig {
-	/** @default 'https://moonrepo.dev/schemas/workspace.json' */
+	/** @default './cache/schemas/workspace.json' */
 	$schema?: string | null;
-	/** Configures code ownership rules for generating a `CODEOWNERS` file. */
+	/**
+	 * Configures code ownership rules for generating a `CODEOWNERS` file.
+	 * @since 1.8.0
+	 */
 	codeowners?: PartialCodeownersConfig | null;
 	/** Configures boundaries and constraints between projects. */
 	constraints?: PartialConstraintsConfig | null;
-	/** Configures Docker integration for the workspace. */
+	/**
+	 * The default/main project within the workspace. When a task is
+	 * ran without a project, the default will be used.
+	 * @since 2.0.0
+	 */
+	defaultProject?: Id | null;
+	/**
+	 * Configures Docker integration for the workspace.
+	 * @since 1.27.0
+	 */
 	docker?: PartialDockerConfig | null;
-	/** Configures experiments across the entire moon workspace. */
+	/**
+	 * Configures experiments across the entire moon workspace.
+	 * @since 1.11.0
+	 */
 	experiments?: PartialExperimentsConfig | null;
 	/**
-	 * Extends one or many workspace configuration file. Supports a relative
-	 * file path or a secure URL.
+	 * Extends one or many workspace configuration file.
+	 * Supports a relative file path or a secure URL.
+	 * @since 1.12.0
 	 */
 	extends?: ExtendsFrom | null;
-	/** Configures extensions that can be executed with `moon ext`. */
-	extensions?: Record<Id, PartialExtensionConfig> | null;
 	/** Configures the generator for scaffolding from templates. */
 	generator?: PartialGeneratorConfig | null;
 	/** Configures aspects of the content hashing engine. */
@@ -1049,8 +1137,6 @@ export interface PartialWorkspaceConfig {
 	/** Configures how and where notifications are sent. */
 	notifier?: PartialNotifierConfig | null;
 	/** Configures aspects of the action pipeline. */
-	runner?: PartialPipelineConfig | null;
-	/** Configures aspects of the action pipeline. */
 	pipeline?: PartialPipelineConfig | null;
 	/**
 	 * Configures all projects within the workspace to create a project graph.
@@ -1058,15 +1144,19 @@ export interface PartialWorkspaceConfig {
 	 * or both values.
 	 */
 	projects?: PartialWorkspaceProjects | null;
+	/** Configures aspects of the remote service. */
+	remote?: PartialRemoteConfig | null;
 	/**
 	 * Collects anonymous usage information, and checks for new moon versions.
 	 *
 	 * @default true
+	 * @env MOON_TELEMETRY
 	 */
 	telemetry?: boolean | null;
-	/** Configures aspects of the remote service. */
-	unstable_remote?: PartialRemoteConfig | null;
-	/** Configures the version control system (VCS). */
+	/**
+	 * Configures the version control system (VCS). Also known as
+	 * source code management (SCM).
+	 */
 	vcs?: PartialVcsConfig | null;
 	/** Requires a specific version of the `moon` binary. */
 	versionConstraint?: string | null;