projen 0.71.13 → 0.71.15

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

@@ -1,81 +0,0 @@
-import { GitHub } from "./github";
-import { Component } from "../component";
-/**
- * The Mergify conditional operators that can be used are: `or` and `and`.
- * Note: The number of nested conditions is limited to 3.
- * @see https://docs.mergify.io/conditions/#combining-conditions-with-operators
- */
-export interface MergifyConditionalOperator {
-    readonly or?: MergifyCondition[];
-    readonly and?: MergifyCondition[];
-}
-export type MergifyCondition = string | MergifyConditionalOperator;
-export interface MergifyRule {
-    /**
-     * The name of the rule. This is not used by the engine directly,
-     * but is used when reporting information about a rule.
-     */
-    readonly name: string;
-    /**
-     * A list of Conditions string that must match against the
-     * pull request for the rule to be applied.
-     * @see https://docs.mergify.io/conditions/#conditions
-     */
-    readonly conditions: MergifyCondition[];
-    /**
-     * A dictionary made of Actions that will be executed on the
-     * matching pull requests.
-     * @see https://docs.mergify.io/actions/#actions
-     */
-    readonly actions: {
-        [action: string]: any;
-    };
-}
-export interface MergifyQueue {
-    /**
-     * The name of the queue.
-     */
-    readonly name: string;
-    /**
-     * Merge method to use.
-     *
-     * Possible values are `merge`, `squash`, `rebase` or `fast-forward`.
-     * `fast-forward` is not supported on queues with `speculative_checks` > 1, `batch_size` > 1, or with `allow_inplace_checks` set to false.
-     *
-     * @default "merge"
-     */
-    readonly mergeMethod?: string;
-    /**
-     * Method to use to update the pull request with its base branch when the speculative check is done in-place.
-     *
-     * Possible values:
-     *  - `merge` to merge the base branch into the pull request.
-     *  - `rebase` to rebase the pull request against its base branch.
-     *
-     * Note that the `rebase` method has some drawbacks, see Mergify docs for details.
-     *
-     * @see https://docs.mergify.com/actions/queue/#queue-rules
-     *
-     * @default - `merge` for all merge methods except `fast-forward` where `rebase` is used
-     */
-    readonly updateMethod?: string;
-    /**
-     * A list of Conditions string that must match against the
-     * pull request for the pull request to be added to the queue.
-     * @see https://docs.mergify.com/conditions/#conditions
-     */
-    readonly conditions: MergifyCondition[];
-}
-export interface MergifyOptions {
-    readonly rules?: MergifyRule[];
-    readonly queues?: MergifyQueue[];
-}
-export declare class Mergify extends Component {
-    private readonly rules;
-    private readonly queues;
-    private yamlFile?;
-    constructor(github: GitHub, options?: MergifyOptions);
-    private createYamlFile;
-    addRule(rule: MergifyRule): void;
-    addQueue(queue: MergifyQueue): void;
-}

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

@@ -1,19 +0,0 @@
-import { GitHub } from "./github";
-import { TextFile } from "../textfile";
-/**
- * Options for `PullRequestTemplate`.
- */
-export interface PullRequestTemplateOptions {
-    /**
-     * The contents of the template. You can use `addLine()` to add additional lines.
-     *
-     * @default - a standard default template will be created.
-     */
-    readonly lines?: string[];
-}
-/**
- * Template for GitHub pull requests.
- */
-export declare class PullRequestTemplate extends TextFile {
-    constructor(github: GitHub, options?: PullRequestTemplateOptions);
-}

package/lib/.types-compat/ts3.9/lib/github/pull-request-lint.d.ts

@@ -1,48 +0,0 @@
-import { GitHub } from ".";
-import { Component } from "../component";
-/**
- * Options for PullRequestLint
- */
-export interface PullRequestLintOptions {
-    /**
-     * Validate that pull request titles follow Conventional Commits.
-     *
-     * @default true
-     * @see https://www.conventionalcommits.org/
-     */
-    readonly semanticTitle?: boolean;
-    /**
-     * Options for validating the conventional commit title linter.
-     * @default - title must start with "feat", "fix", or "chore"
-     */
-    readonly semanticTitleOptions?: SemanticTitleOptions;
-    /**
-     * Github Runner selection labels
-     * @default ["ubuntu-latest"]
-     */
-    readonly runsOn?: string[];
-}
-/**
- * Options for linting that PR titles follow Conventional Commits.
- * @see https://www.conventionalcommits.org/
- */
-export interface SemanticTitleOptions {
-    /**
-     * Configure a list of commit types that are allowed.
-     * @default ["feat", "fix", "chore"]
-     */
-    readonly types?: string[];
-    /**
-     * Configure that a scope must always be provided.
-     * e.g. feat(ui), fix(core)
-     * @default false
-     */
-    readonly requireScope?: boolean;
-}
-/**
- * Configure validations to run on GitHub pull requests.
- * Only generates a file if at least one linter is configured.
- */
-export declare class PullRequestLint extends Component {
-    constructor(github: GitHub, options?: PullRequestLintOptions);
-}

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

@@ -1,8 +0,0 @@
-import { StaleBehavior } from "./stale";
-interface Options {
-    readonly stale: number;
-    readonly close: number;
-    readonly type: string;
-}
-export declare function renderBehavior(behavior: StaleBehavior | undefined, opts: Options): Partial<StaleBehavior>;
-export {};

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

@@ -1,85 +0,0 @@
-import { GitHub } from "./github";
-import { Component } from "../component";
-/**
- * Options for `Stale`.
- */
-export interface StaleOptions {
-    /**
-     * How to handle stale pull requests.
-     *
-     * @default - By default, pull requests with no activity will be marked as
-     * stale after 14 days and closed within 2 days with relevant comments.
-     */
-    readonly pullRequest?: StaleBehavior;
-    /**
-     * How to handle stale issues.
-     *
-     * @default - By default, stale issues with no activity will be marked as
-     * stale after 60 days and closed within 7 days.
-     */
-    readonly issues?: StaleBehavior;
-    /**
-     * Github Runner selection labels
-     * @default ["ubuntu-latest"]
-     */
-    readonly runsOn?: string[];
-}
-/**
- * Stale behavior.
- */
-export interface StaleBehavior {
-    /**
-     * Determines if this behavior is enabled.
-     *
-     * Same as setting `daysBeforeStale` and `daysBeforeClose` to `-1`.
-     *
-     * @default true
-     */
-    readonly enabled?: boolean;
-    /**
-     * How many days until the issue or pull request is marked as "Stale". Set to -1 to disable.
-     * @default -
-     */
-    readonly daysBeforeStale?: number;
-    /**
-     * Days until the issue/PR is closed after it is marked as "Stale". Set to -1 to disable.
-     * @default -
-     */
-    readonly daysBeforeClose?: number;
-    /**
-     * The comment to add to the issue/PR when it becomes stale.
-     * @default "This pull request is now marked as stale because hasn\'t seen activity for a while. Add a comment or it will be closed soon."
-     */
-    readonly staleMessage?: string;
-    /**
-     * The comment to add to the issue/PR when it's closed
-     *
-     * @default "Closing this pull request as it hasn\'t seen activity for a while. Please add a comment @mentioning a maintainer when you are ready to continue."
-     */
-    readonly closeMessage?: string;
-    /**
-     * The label to apply to the issue/PR when it becomes stale.
-     * @default "stale"
-     */
-    readonly staleLabel?: string;
-    /**
-     * Label which exempt an issue/PR from becoming stale. Set to `[]` to disable.
-     *
-     * @default - ["backlog"]
-     */
-    readonly exemptLabels?: string[];
-}
-/**
- * Warns and then closes issues and PRs that have had no activity for a specified amount of time.
- *
- * The default configuration will:
- *
- *  * Add a "Stale" label to pull requests after 14 days and closed after 2 days
- *  * Add a "Stale" label to issues after 60 days and closed after 7 days
- *  * If a comment is added, the label will be removed and timer is restarted.
- *
- * @see https://github.com/actions/stale
- */
-export declare class Stale extends Component {
-    constructor(github: GitHub, options?: StaleOptions);
-}

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

@@ -1,119 +0,0 @@
-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

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

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

@@ -1,169 +0,0 @@
-import { GitIdentity, GithubCredentials } 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, the action can optionally fail the job.
-     *
-     * @param options Options
-     * @returns Job steps
-     */
-    static uploadGitPatch(options: UploadGitPatchOptions): JobStep[];
-    /**
-     * Checks out a repository and applies a git patch that was created using
-     * `uploadGitPatch`.
-     *
-     * @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 setupGitIdentity(id: GitIdentity): JobStep[];
-    /**
-     * A step that creates a pull request based on the current repo state.
-     *
-     * @param options Options
-     * @returns Job steps
-     */
-    static createPullRequest(options: CreatePullRequestOptions): JobStep[];
-}
-/**
- * Options for `checkoutWithPatch`.
- */
-export interface CheckoutWithPatchOptions {
-    /**
-     * The name of the artifact the patch is stored as.
-     * @default ".repo.patch"
-     */
-    readonly patchFile?: 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;
-    /**
-     * 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 `uploadGitPatch`.
- */
-export interface UploadGitPatchOptions {
-    /**
-     * The step ID which produces the output which indicates if a patch was created.
-     */
-    readonly stepId: string;
-    /**
-     * The name of the step.
-     * @default "Find mutations"
-     */
-    readonly stepName?: string;
-    /**
-     * The name of the artifact the patch is stored as.
-     * @default ".repo.patch"
-     */
-    readonly patchFile?: 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;
-}
-export interface CreatePullRequestOptions {
-    /**
-     * The step ID which produces the output which indicates if a patch was created.
-     * @default "create_pr"
-     */
-    readonly stepId?: string;
-    /**
-     * The name of the step displayed on GitHub.
-     * @default "Create Pull Request"
-     */
-    readonly stepName?: string;
-    /**
-     * The job credentials used to create the pull request.
-     *
-     * Provided credentials must have permissions to create a pull request on the repository.
-     */
-    readonly credentials?: GithubCredentials;
-    /**
-     * The name of the workflow that will create the PR
-     */
-    readonly workflowName: string;
-    /**
-     * The full title used to create the pull request.
-     *
-     * If PR titles are validated in this repo, the title should comply with the respective rules.
-     */
-    readonly pullRequestTitle: string;
-    /**
-     * Description added to the pull request.
-     *
-     * Providence information are automatically added.
-     */
-    readonly pullRequestDescription: string;
-    /**
-     * Sets the pull request base branch.
-     *
-     * @default - The branch checked out in the workflow.
-     */
-    readonly baseBranch?: string;
-    /**
-     * The pull request branch name.
-     *
-     * @default `github-actions/${options.workflowName}`
-     */
-    readonly branchName?: string;
-    /**
-     * The git identity used to create the commit.
-     * @default - the default github-actions user
-     */
-    readonly gitIdentity?: GitIdentity;
-    /**
-     * Add Signed-off-by line by the committer at the end of the commit log message.
-     *
-     * @default true
-     */
-    readonly signoff?: boolean;
-    /**
-     * Labels to apply on the PR.
-     *
-     * @default - no labels.
-     */
-    readonly labels?: string[];
-    /**
-     * Assignees to add on the PR.
-     *
-     * @default - no assignees
-     */
-    readonly assignees?: string[];
-}

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

@@ -1,39 +0,0 @@
-import { CheckoutWithPatchOptions, CreatePullRequestOptions } from ".";
-import { Job } from "./workflows-model";
-/**
- * A set of utility functions for creating jobs in GitHub Workflows.
- */
-export declare class WorkflowJobs {
-    /**
-     * Creates a pull request with the changes of a patch file.
-     *
-     * @returns Job
-     */
-    static pullRequestFromPatch(options: PullRequestFromPatchOptions): Job;
-}
-export interface PullRequestPatchSource extends CheckoutWithPatchOptions {
-    /**
-     * The id of the job that created the patch file
-     */
-    readonly jobId: string;
-    /**
-     * The name of the output that indicates if a patch has been created
-     */
-    readonly outputName: string;
-}
-export interface PullRequestFromPatchOptions extends CreatePullRequestOptions {
-    /**
-     * Information about the patch that is used to create the pull request.
-     */
-    readonly patch: PullRequestPatchSource;
-    /**
-     * The name of the job displayed on GitHub.
-     * @default "Create Pull Request"
-     */
-    readonly jobName?: string;
-    /**
-     * Github Runner selection labels
-     * @default ["ubuntu-latest"]
-     */
-    readonly runsOn?: string[];
-}