projen

import { GitIdentity } from "./task-workflow"; import { JobStepConfiguration, JobStep } from "./workflows-model"; /** * A collection of very commonly used, individual, GitHub Workflow Job steps. */ export declare class WorkflowSteps { /** * Checks out a repository. * * @param options Options to configure the `checkout` JobStep * @returns A JobStep that checks out a repository */ static checkout(options?: CheckoutOptions): JobStep; /** * Configures the git identity (user name and email). * * @param options Options to configure the git identity JobStep * @returns Job step that configures the provided git identity */ static setupGitIdentity(options: SetupGitIdentityOptions): JobStep; /** * Checks if a tag exists. * * Requires a checkout step to have been run before this step with "fetch-depth" set to "0". * * Outputs: * - `exists`: A string value of 'true' or 'false' indicating if the tag exists. * * @param tag The tag to check. You may use valid bash code instead of a literal string in this field. * @param options Options to configure the `tag-exists` JobStep * @returns Job step that checks if the provided tag exists */ static tagExists(tag: string, options: JobStepConfiguration): JobStep; /** * Uploads an artifact. * * @param options Options to configure the `upload-artifact` JobStep * @returns A JobStep that uploads an artifact */ static uploadArtifact(options: UploadArtifactOptions): JobStep; /** * Downloads an artifact. * * @param options Options to configure the `download-artifact` JobStep * @returns A JobStep that downloads an artifact */ static downloadArtifact(options?: DownloadArtifactOptions): JobStep; /** * Simple adapter to ensure we only include the necessary fields for a JobStepConfiguration. */ private static buildJobStepConfig; } export interface CheckoutOptions extends JobStepConfiguration { /** * Options for `checkout`. */ readonly with?: CheckoutWith; } /** * Options for `checkout`. */ export interface CheckoutWith { /** * Number of commits to fetch. 0 indicates all history for all branches and tags. * * @default 1 */ readonly fetchDepth?: number; /** * Whether LFS is enabled for the GitHub repository * * @default false */ readonly lfs?: boolean; /** * Branch or tag name. * @default - the default branch is implicitly used */ readonly ref?: string; /** * The repository (owner/repo) to use. * @default - the default repository is implicitly used */ readonly repository?: string; /** * A GitHub token to use when checking out the repository. * * If the intent is to push changes back to the branch, then you must use a * PAT with `repo` (and possibly `workflows`) permissions. * @default - the default GITHUB_TOKEN is implicitly used */ readonly token?: string; /** * Relative path under $GITHUB_WORKSPACE to place the repository * @default - $GITHUB_WORKSPACE */ readonly path?: string; } export interface SetupGitIdentityOptions extends JobStepConfiguration { /** * The identity to use. */ readonly gitIdentity: GitIdentity; } export interface UploadArtifactWith { /** * Name of the artifact to upload. * * @default "artifact" */ readonly name?: string; /** * A file, directory or wildcard pattern that describes what to upload */ readonly path: string; /** * The desired behavior if no files are found using the provided path. * Available Options: * warn: Output a warning but do not fail the action * error: Fail the action with an error message * ignore: Do not output any warnings or errors, the action does not fail * * @default "warn" */ readonly ifNoFilesFound?: "error" | "warn" | "ignore"; /** * Duration after which artifact will expire in days. 0 means using default repository retention. * * Minimum 1 day. * Maximum 90 days unless changed from the repository settings page. * * @default - The default repository retention */ readonly retentionDays?: number; /** * The level of compression for Zlib to be applied to the artifact archive. * * The value can range from 0 to 9. * For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads. * * @default 6 */ readonly compressionLevel?: number; /** * Whether action should overwrite an existing artifact with the same name (should one exist) * * Introduced in v4 and represents a breaking change from the behavior of the v3 action. * To maintain backwards compatibility with existing, this should be set the `true` (the default). * * @default true */ readonly overwrite?: boolean; /** * Whether to include hidden files in the provided path in the artifact * * The file contents of any hidden files in the path should be validated before enabled this to avoid uploading sensitive information. * * @default false */ readonly includeHiddenFiles?: boolean; } export interface UploadArtifactOptions extends JobStepConfiguration { /** * Options for `upload-artifact`. */ readonly with: UploadArtifactWith; } export interface DownloadArtifactWith { /** * Name of the artifact to download * * @default - If unspecified, all artifacts for the run are downloaded */ readonly name?: string; /** * A file, directory or wildcard pattern that describes what to download. Supports basic tilde expansion. * * @default - $GITHUB_WORKSPACE */ readonly path?: string; /** * A glob pattern to the artifacts that should be downloaded * This is ignored if name is specified */ readonly pattern?: string; /** * When multiple artifacts are matched, this changes the behavior of the destination directories * If true, the downloaded artifacts will be in the same directory specified by path * If false, the downloaded artifacts will be extracted into individual named directories within the specified path * * @default false */ readonly mergeMultiple?: boolean; /** * The GitHub token used to authenticate with the GitHub API to download artifacts from a different repository or from a different workflow run * * @default - If unspecified, the action will download artifacts from the current repo and the current workflow run */ readonly token?: string; /** * The repository owner and the repository name joined together by "/" * If github-token is specified, this is the repository that artifacts will be downloaded from * * @default - ${{ github.repository }} */ readonly repository?: string; /** * The id of the workflow run where the desired download artifact was uploaded from * If github-token is specified, this is the run that artifacts will be downloaded from * * @default - ${{ github.run_id }} */ readonly runId?: string; } export interface DownloadArtifactOptions extends JobStepConfiguration { /** * Options for `download-artifact`. */ readonly with: DownloadArtifactWith; }