projen 0.70.2 → 0.70.4

package/lib/.types-compat/ts3.9/lib/github/task-workflow.d.ts

@@ -0,0 +1,119 @@
+import { GitHub } from "./github";
+import { GithubWorkflow } from "./workflows";
+import { ContainerOptions, JobPermissions, JobStep, JobStepOutput, Triggers } from "./workflows-model";
+import { Task } from "../task";
+export interface TaskWorkflowOptions {
+    /**
+     * The workflow name.
+     */
+    readonly name: string;
+    /**
+     * The primary job id.
+     * @default "build"
+     */
+    readonly jobId?: string;
+    /**
+     * @default - default image
+     */
+    readonly container?: ContainerOptions;
+    /**
+     * Adds an 'if' condition to the workflow.
+     */
+    readonly condition?: string;
+    /**
+     * A directory name which contains artifacts to be uploaded (e.g. `dist`).
+     * If this is set, the contents of this directory will be uploaded as an
+     * artifact at the end of the workflow run, even if other steps fail.
+     *
+     * @default - not set
+     */
+    readonly artifactsDirectory?: string;
+    /**
+     * The triggers for the workflow.
+     *
+     * @default - by default workflows can only be triggered by manually.
+     */
+    readonly triggers?: Triggers;
+    /**
+     * Initial steps to run before the source code checkout.
+     *
+     * @default - not set
+     */
+    readonly preCheckoutSteps?: JobStep[];
+    /**
+     * Override for the `with` property of the source code checkout step.
+     *
+     * @default - not set
+     */
+    readonly checkoutWith?: Record<string, any>;
+    /**
+     * Steps to run before the main build step.
+     *
+     * @default - not set
+     */
+    readonly preBuildSteps?: JobStep[];
+    /**
+     * The main task to be executed.
+     */
+    readonly task: Task;
+    /**
+     * Actions to run after the main build step.
+     *
+     * @default - not set
+     */
+    readonly postBuildSteps?: JobStep[];
+    /**
+     * Workflow environment variables.
+     * @default {}
+     */
+    readonly env?: Record<string, string>;
+    /**
+     * Permissions for the build job.
+     */
+    readonly permissions: JobPermissions;
+    /**
+     * Mapping of job output names to values/expressions.
+     *
+     * @default {}
+     */
+    readonly outputs?: {
+        [name: string]: JobStepOutput;
+    };
+    /**
+     * The git identity to use in this workflow.
+     */
+    readonly gitIdentity?: GitIdentity;
+    /**
+     * Github Runner selection labels
+     * @default ["ubuntu-latest"]
+     */
+    readonly runsOn?: string[];
+    /**
+     * Whether to download files from Git LFS for this workflow
+     *
+     * @default - Use the setting on the corresponding GitHub project
+     */
+    readonly downloadLfs?: boolean;
+}
+/**
+ * A GitHub workflow for common build tasks within a project.
+ */
+export declare class TaskWorkflow extends GithubWorkflow {
+    private readonly github;
+    readonly jobId: string;
+    readonly artifactsDirectory?: string;
+    constructor(github: GitHub, options: TaskWorkflowOptions);
+}
+/**
+ * Represents the git identity.
+ */
+export interface GitIdentity {
+    /**
+     * The name of the user.
+     */
+    readonly name: string;
+    /**
+     * The email address of the git user.
+     */
+    readonly email: string;
+}

package/lib/.types-compat/ts3.9/lib/github/util.d.ts

@@ -0,0 +1 @@
+export declare function secretToString(secretName: string): string;

package/lib/.types-compat/ts3.9/lib/github/workflow-actions.d.ts

@@ -0,0 +1,78 @@
+import { GitIdentity } from ".";
+import { JobStep } from "./workflows-model";
+/**
+ * A set of utility functions for creating GitHub actions in workflows.
+ */
+export declare class WorkflowActions {
+    /**
+     * Creates a .patch file from the current git diff and uploads it as an
+     * artifact. Use `checkoutWithPatch` to download and apply in another job.
+     *
+     * If a patch was uploaded,
+     *
+     * @param options Options
+     * @returns Job steps
+     */
+    static createUploadGitPatch(options: CreateUploadGitPatchOptions): JobStep[];
+    /**
+     * Checks out a repository and applies a git patch that was created using
+     * `createUploadGitPatch`.
+     *
+     * @param options Options
+     * @returns Job steps
+     */
+    static checkoutWithPatch(options?: CheckoutWithPatchOptions): JobStep[];
+    /**
+     * Configures the git identity (user name and email).
+     * @param id The identity to use
+     * @returns Job steps
+     */
+    static setGitIdentity(id: GitIdentity): JobStep[];
+}
+/**
+ * Options for `checkoutWithPatch`.
+ */
+export interface CheckoutWithPatchOptions {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Whether LFS is enabled for the GitHub repository
+     *
+     * @default false
+     */
+    readonly lfs?: boolean;
+}
+/**
+ * Options for `createUploadGitPatch`.
+ */
+export interface CreateUploadGitPatchOptions {
+    /**
+     * The step ID which produces the output which indicates if a patch was created.
+     */
+    readonly stepId: string;
+    /**
+     * The name of the output to emit. It will be set to `true` if there was a diff.
+     */
+    readonly outputName: string;
+    /**
+     * Fail if a mutation was found and print this error message.
+     * @default - do not fail upon mutation
+     */
+    readonly mutationError?: string;
+}