@sentry/craft/dist/config.d.ts

import { CraftProjectConfig, GithubGlobalConfig } from './schemas/project_config';
import { BaseArtifactProvider } from './artifact_providers/base';
import { BaseStatusProvider } from './status_providers/base';
export declare const CONFIG_FILE_NAME = ".craft.yml";
/**
 * The default prefix for the release branch.
 */
export declare const DEFAULT_RELEASE_BRANCH_NAME = "release";
/**
 * Searches the current and parent directories for the configuration file
 *
 * Returns "undefined" if no file was found.
 */
export declare function findConfigFile(): string | undefined;
/**
 * Returns project configuration (.craft.yml) file path
 *
 * Throws an error if the file cannot be found.
 */
export declare function getConfigFilePath(): string;
/**
 * Returns the path to the directory that contains the configuration file
 *
 * Returns "undefined" if no configuration file can be found.
 */
export declare function getConfigFileDir(): string | undefined;
/**
 * Reads JSON schema for project configuration
 */
export declare function getProjectConfigSchema(): any;
/**
 * Parses and validate passed configuration object
 *
 * Throw an error is the object cannot be properly parsed as configuration.
 *
 * @param rawConfig Raw project configuration object
 */
export declare function validateConfiguration(rawConfig: Record<string, any>): CraftProjectConfig;
/**
 * Returns the parsed configuration file contents
 */
export declare function getConfiguration(): CraftProjectConfig;
/**
 * Checks that the current "craft" version is compatible with the configuration
 *
 * "minVersion" configuration parameter specifies the minimal version of "craft"
 * that can work with the given configuration.
 */
export declare function checkMinimalConfigVersion(): void;
/**
 * Return the parsed global Github configuration
 */
export declare function getGlobalGithubConfig(): GithubGlobalConfig;
/**
 * Gets git tag prefix from configuration
 */
export declare function getGitTagPrefix(): string;
/**
 * Create an artifact provider instance from the spec in the configuration file
 *
 * @returns An instance of artifact provider (which may be the dummy
 * NoneArtifactProvider if artifact storage is disabled).
 */
export declare function getArtifactProviderFromConfig(): BaseArtifactProvider;
/**
 * Create a status provider instance from the spec in the configuration file
 *
 * @returns An instance of status provider
 */
export declare function getStatusProviderFromConfig(): BaseStatusProvider;
//# sourceMappingURL=config.d.ts.map