projen 0.71.13 → 0.71.15

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

@@ -1,41 +0,0 @@
-import { GitHub } from "./github";
-import { Component } from "../component";
-export interface AutoMergeOptions {
-    /**
-     * Number of approved code reviews.
-     * @default 1
-     */
-    readonly approvedReviews?: number;
-    /**
-     * List of labels that will prevent auto-merging.
-     * @default ['do-not-merge']
-     */
-    readonly blockingLabels?: string[];
-}
-/**
- * Sets up mergify to merging approved pull requests.
- *
- * If `buildJob` is specified, the specified GitHub workflow job ID is required
- * to succeed in order for the PR to be merged.
- *
- * `approvedReviews` specified the number of code review approvals required for
- * the PR to be merged.
- */
-export declare class AutoMerge extends Component {
-    private readonly lazyConditions;
-    constructor(github: GitHub, options?: AutoMergeOptions);
-    /**
-     * Adds conditions to the auto merge rule.
-     * @param conditions The conditions to add (mergify syntax)
-     */
-    addConditions(...conditions: string[]): void;
-    /**
-     * Adds conditions that will be rendered only during synthesis.
-     * @param later The later
-     */
-    addConditionsLater(later: IAddConditionsLater): void;
-    private renderConditions;
-}
-export interface IAddConditionsLater {
-    render(): string[];
-}

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

@@ -1,20 +0,0 @@
-import { GitIdentity } from ".";
-/**
- * Name of the artifact produced by the build job. Its contains the entire
- * working directory.
- */
-export declare const BUILD_ARTIFACT_NAME = "build-artifact";
-/**
- * Represents the github-actions user.
- *
- * Use this when you need to perform a commit as part of your workflow.
- */
-export declare const DEFAULT_GITHUB_ACTIONS_USER: GitIdentity;
-/**
- * Name of the permission back up file to include in the build artifact
- * to work around a GitHub Action bug that does not preserve file mode
- * permissions across upload and download actions.
- *
- * See {@link https://github.com/actions/upload-artifact/issues/38}
- */
-export declare const PERMISSION_BACKUP_FILE = "permissions-backup.acl";

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

@@ -1,247 +0,0 @@
-import { GitHub } from "./github";
-import { Component } from "../component";
-export interface DependabotOptions {
-    /**
-     * How often to check for new versions and raise pull requests.
-     *
-     * @default ScheduleInterval.DAILY
-     */
-    readonly scheduleInterval?: DependabotScheduleInterval;
-    /**
-     * The strategy to use when edits manifest and lock files.
-     *
-     * @default VersioningStrategy.LOCKFILE_ONLY The default is to only update the
-     * lock file because package.json is controlled by projen and any outside
-     * updates will fail the build.
-     */
-    readonly versioningStrategy?: VersioningStrategy;
-    /**
-     * You can use the `ignore` option to customize which dependencies are updated.
-     * The ignore option supports the following options.
-     * @default []
-     */
-    readonly ignore?: DependabotIgnore[];
-    /**
-     * Ignores updates to `projen`.
-     *
-     * This is required since projen updates may cause changes in committed files
-     * and anti-tamper checks will fail.
-     *
-     * Projen upgrades are covered through the `ProjenUpgrade` class.
-     *
-     * @default true
-     */
-    readonly ignoreProjen?: boolean;
-    /**
-     * List of labels to apply to the created PR's.
-     */
-    readonly labels?: string[];
-    /**
-     * Map of package registries to use
-     * @default - use public registries
-     */
-    readonly registries?: {
-        [name: string]: DependabotRegistry;
-    };
-}
-/**
- * Use to add private registry support for dependabot
- * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries
- */
-export interface DependabotRegistry {
-    /**
-     * Registry type e.g. 'npm-registry' or 'docker-registry'
-     */
-    readonly type: DependabotRegistryType;
-    /**
-     * Url for the registry e.g. 'https://npm.pkg.github.com' or 'registry.hub.docker.com'
-     */
-    readonly url: string;
-    /**
-     * The username that Dependabot uses to access the registry
-     * @default - do not authenticate
-     */
-    readonly username?: string;
-    /**
-     * A reference to a Dependabot secret containing the password for the specified user
-     * @default undefined
-     */
-    readonly password?: string;
-    /**
-     * A reference to a Dependabot secret containing an access key for this registry
-     * @default undefined
-     */
-    readonly key?: string;
-    /**
-     * Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'
-     * @default undefined
-     */
-    readonly token?: string;
-    /**
-     * For registries with type: python-index, if the boolean value is true, pip
-     * esolves dependencies by using the specified URL rather than the base URL of
-     * the Python Package Index (by default https://pypi.org/simple)
-     * @default undefined
-     */
-    readonly replacesBase?: boolean;
-    /**
-     * Used with the hex-organization registry type.
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization
-     * @default undefined
-     */
-    readonly organization?: string;
-}
-/**
- * Each configuration type requires you to provide particular settings.
- * Some types allow more than one way to connect
- * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries
- */
-export declare enum DependabotRegistryType {
-    /**
-     * The composer-repository type supports username and password.
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#composer-repository
-     */
-    COMPOSER_REGISTRY = "composer-registry",
-    /**
-     * The docker-registry type supports username and password.
-     * The docker-registry type can also be used to pull from Amazon ECR using static AWS credentials
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#docker-registry
-     */
-    DOCKER_REGISTRY = "docker-registry",
-    /**
-     * The git type supports username and password
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#git
-     */
-    GIT = "git",
-    /**
-     * The hex-organization type supports organization and key
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization
-     */
-    HEX_ORGANIZATION = "hex-organization",
-    /**
-     * The maven-repository type supports username and password, or token
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#maven-repository
-     */
-    MAVEN_REPOSITORY = "maven-repository",
-    /**
-     * The npm-registry type supports username and password, or token
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#npm-registry
-     */
-    NPM_REGISTRY = "npm-registry",
-    /**
-     * The nuget-feed type supports username and password, or token
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#nuget-feed
-     */
-    NUGET_FEED = "nuget-feed",
-    /**
-     * The python-index type supports username and password, or token
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#python-index
-     */
-    PYTHON_INDEX = "python-index",
-    /**
-     * The rubygems-server type supports username and password, or token
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#rubygems-server
-     */
-    RUBYGEMS_SERVER = "rubygems-server",
-    /**
-     * The terraform-registry type supports a token
-     * @see https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#terraform-registry
-     */
-    TERRAFORM_REGISTRY = "terraform-registry"
-}
-/**
- * You can use the `ignore` option to customize which dependencies are updated.
- * The ignore option supports the following options.
- */
-export interface DependabotIgnore {
-    /**
-     * Use to ignore updates for dependencies with matching names, optionally
-     * using `*` to match zero or more characters.
-     *
-     * For Java dependencies, the format of the dependency-name attribute is:
-     * `groupId:artifactId`, for example: `org.kohsuke:github-api`.
-     */
-    readonly dependencyName: string;
-    /**
-     * Use to ignore specific versions or ranges of versions. If you want to
-     * define a range, use the standard pattern for the package manager (for
-     * example: `^1.0.0` for npm, or `~> 2.0` for Bundler).
-     */
-    readonly versions?: string[];
-}
-/**
- * How often to check for new versions and raise pull requests for version
- * updates.
- */
-export declare enum DependabotScheduleInterval {
-    /**
-     * Runs on every weekday, Monday to Friday.
-     */
-    DAILY = "daily",
-    /**
-     * Runs once each week. By default, this is on Monday.
-     */
-    WEEKLY = "weekly",
-    /**
-     * Runs once each month. This is on the first day of the month.
-     */
-    MONTHLY = "monthly"
-}
-/**
- * The strategy to use when edits manifest and lock files.
- */
-export declare enum VersioningStrategy {
-    /**
-     * Only create pull requests to update lockfiles updates. Ignore any new
-     * versions that would require package manifest changes.
-     */
-    LOCKFILE_ONLY = "lockfile-only",
-    /**
-     * - For apps, the version requirements are increased.
-     * - For libraries, the range of versions is widened.
-     */
-    AUTO = "auto",
-    /**
-     * Relax the version requirement to include both the new and old version, when
-     * possible.
-     */
-    WIDEN = "widen",
-    /**
-     * Always increase the version requirement to match the new version.
-     */
-    INCREASE = "increase",
-    /**
-     * Increase the version requirement only when required by the new version.
-     */
-    INCREASE_IF_NECESSARY = "increase-if-necessary"
-}
-/**
- * Defines dependabot configuration for node projects.
- *
- * Since module versions are managed in projen, the versioning strategy will be
- * configured to "lockfile-only" which means that only updates that can be done
- * on the lockfile itself will be proposed.
- */
-export declare class Dependabot extends Component {
-    /**
-     * The raw dependabot configuration.
-     * @see https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
-     */
-    readonly config: any;
-    /**
-     * Whether or not projen is also upgraded in this config,
-     */
-    readonly ignoresProjen: boolean;
-    private readonly ignore;
-    constructor(github: GitHub, options?: DependabotOptions);
-    /**
-     * Ignores a dependency from automatic updates.
-     *
-     * @param dependencyName Use to ignore updates for dependencies with matching
-     * names, optionally using `*` to match zero or more characters.
-     * @param versions Use to ignore specific versions or ranges of versions. If
-     * you want to define a range, use the standard pattern for the package
-     * manager (for example: `^1.0.0` for npm, or `~> 2.0` for Bundler).
-     */
-    addIgnore(dependencyName: string, ...versions: string[]): void;
-}

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

@@ -1,58 +0,0 @@
-import { JobStep, AppPermissions } from "./workflows-model";
-/**
- * Options for `GithubCredentials.fromPersonalAccessToken`
- */
-export interface GithubCredentialsPersonalAccessTokenOptions {
-    readonly secret?: string;
-}
-/**
- * Options for `GithubCredentials.fromApp`
- */
-export interface GithubCredentialsAppOptions {
-    readonly appIdSecret?: string;
-    readonly privateKeySecret?: string;
-    /**
-     * The permissions granted to the token.
-     *
-     * @default - all permissions granted to the app
-     */
-    readonly permissions?: AppPermissions;
-}
-/**
- * Represents a method of providing GitHub API access for projen workflows.
- */
-export declare class GithubCredentials {
-    private readonly options;
-    /**
-     * Provide API access through a GitHub personal access token.
-     *
-     * The token must be added as a secret to the GitHub repo, and the name of the
-     * secret can be specified here.
-     *
-     * @see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
-     * @default - a secret named "PROJEN_GITHUB_TOKEN"
-     */
-    static fromPersonalAccessToken(options?: GithubCredentialsPersonalAccessTokenOptions): GithubCredentials;
-    /**
-     * Provide API access through a GitHub App.
-     *
-     * The GitHub App must be installed on the GitHub repo, its App ID and a
-     * private key must be added as secrets to the repo. The name of the secrets
-     * can be specified here.
-     *
-     * @see https://docs.github.com/en/developers/apps/building-github-apps/creating-a-github-app
-     * @see https://projen.io/github.html#github-app
-     * @default - app id stored in "PROJEN_APP_ID" and private key stored in "PROJEN_APP_PRIVATE_KEY" with all permissions attached to the app
-     */
-    static fromApp(options?: GithubCredentialsAppOptions): GithubCredentials;
-    private constructor();
-    /**
-     * Setup steps to obtain GitHub credentials.
-     */
-    get setupSteps(): JobStep[];
-    /**
-     * The value to use in a workflow when a GitHub token is expected. This
-     * typically looks like "${{ some.path.to.a.value }}".
-     */
-    get tokenRef(): string;
-}

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

@@ -1,177 +0,0 @@
-import { AutoApprove, AutoApproveOptions } from "./auto-approve";
-import { AutoMergeOptions } from "./auto-merge";
-import { GitHub, GitHubOptions } from "./github";
-import { GithubCredentials } from "./github-credentials";
-import { MergifyOptions } from "./mergify";
-import { StaleOptions } from "./stale";
-import { Gitpod } from "../gitpod";
-import { Project, ProjectOptions, ProjectType } from "../project";
-import { SampleReadmeProps } from "../readme";
-import { DevContainer, VsCode } from "../vscode";
-/**
- * Options for `GitHubProject`.
- */
-export interface GitHubProjectOptions extends ProjectOptions {
-    /**
-     * Add a Gitpod development environment
-     *
-     * @default false
-     */
-    readonly gitpod?: boolean;
-    /**
-     * Enable VSCode integration.
-     *
-     * Enabled by default for root projects. Disabled for non-root projects.
-     *
-     * @default true
-     */
-    readonly vscode?: boolean;
-    /**
-     * Enable GitHub integration.
-     *
-     * Enabled by default for root projects. Disabled for non-root projects.
-     *
-     * @default true
-     */
-    readonly github?: boolean;
-    /**
-     * Options for GitHub integration
-     *
-     * @default - see GitHubOptions
-     */
-    readonly githubOptions?: GitHubOptions;
-    /**
-     * Whether mergify should be enabled on this repository or not.
-     *
-     * @default true
-     * @deprecated use `githubOptions.mergify` instead
-     */
-    readonly mergify?: boolean;
-    /**
-     * Options for mergify
-     *
-     * @default - default options
-     * @deprecated use `githubOptions.mergifyOptions` instead
-     */
-    readonly mergifyOptions?: MergifyOptions;
-    /**
-     * Add a VSCode development environment (used for GitHub Codespaces)
-     *
-     * @default false
-     */
-    readonly devContainer?: boolean;
-    /**
-     * Add a `clobber` task which resets the repo to origin.
-     * @default - true, but false for subprojects
-     */
-    readonly clobber?: boolean;
-    /**
-     * The README setup.
-     *
-     * @default - { filename: 'README.md', contents: '# replace this' }
-     * @example "{ filename: 'readme.md', contents: '# title' }"
-     */
-    readonly readme?: SampleReadmeProps;
-    /**
-     * Which type of project this is (library/app).
-     * @default ProjectType.UNKNOWN
-     * @deprecated no longer supported at the base project level
-     */
-    readonly projectType?: ProjectType;
-    /**
-     * Enable and configure the 'auto approve' workflow.
-     * @default - auto approve is disabled
-     */
-    readonly autoApproveOptions?: AutoApproveOptions;
-    /**
-     * Enable automatic merging on GitHub. Has no effect if `github.mergify`
-     * is set to false.
-     * @default true
-     */
-    readonly autoMerge?: boolean;
-    /**
-     * Configure options for automatic merging on GitHub. Has no effect if
-     * `github.mergify` or `autoMerge` is set to false.
-     *
-     * @default - see defaults in `AutoMergeOptions`
-     */
-    readonly autoMergeOptions?: AutoMergeOptions;
-    /**
-     * Auto-close stale issues and pull requests. To disable set `stale` to `false`.
-     *
-     * @default - see defaults in `StaleOptions`
-     */
-    readonly staleOptions?: StaleOptions;
-    /**
-     * Auto-close of stale issues and pull request. See `staleOptions` for options.
-     *
-     * @default false
-     */
-    readonly stale?: boolean;
-    /**
-     * Choose a method of providing GitHub API access for projen workflows.
-     *
-     * @default - use a personal access token named PROJEN_GITHUB_TOKEN
-     */
-    readonly projenCredentials?: GithubCredentials;
-    /**
-     * The name of a secret which includes a GitHub Personal Access Token to be
-     * used by projen workflows. This token needs to have the `repo`, `workflows`
-     * and `packages` scope.
-     *
-     * @default "PROJEN_GITHUB_TOKEN"
-     * @deprecated use `projenCredentials`
-     */
-    readonly projenTokenSecret?: string;
-}
-/**
- * GitHub-based project.
- *
- * @deprecated This is a *temporary* class. At the moment, our base project
- * types such as `NodeProject` and `JavaProject` are derived from this, but we
- * want to be able to use these project types outside of GitHub as well. One of
- * the next steps to address this is to abstract workflows so that different
- * "engines" can be used to implement our CI/CD solutions.
- */
-export declare class GitHubProject extends Project {
-    /**
-     * Access all github components.
-     *
-     * This will be `undefined` for subprojects.
-     */
-    readonly github: GitHub | undefined;
-    /**
-     * Access all VSCode components.
-     *
-     * This will be `undefined` for subprojects.
-     */
-    readonly vscode: VsCode | undefined;
-    /**
-     * Access for Gitpod
-     *
-     * This will be `undefined` if gitpod boolean is false
-     */
-    readonly gitpod: Gitpod | undefined;
-    /**
-     * Access for .devcontainer.json (used for GitHub Codespaces)
-     *
-     * This will be `undefined` if devContainer boolean is false
-     */
-    readonly devContainer: DevContainer | undefined;
-    readonly projectType: ProjectType;
-    /**
-     * Auto approve set up for this project.
-     */
-    readonly autoApprove?: AutoApprove;
-    constructor(options: GitHubProjectOptions);
-    /**
-     * Marks the provided file(s) as being generated. This is achieved using the
-     * github-linguist attributes. Generated files do not count against the
-     * repository statistics and language breakdown.
-     *
-     * @param glob the glob pattern to match (could be a file path).
-     *
-     * @see https://github.com/github/linguist/blob/master/docs/overrides.md
-     */
-    annotateGenerated(glob: string): void;
-}

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

@@ -1,110 +0,0 @@
-import { GitHubActionsProvider } from "./actions-provider";
-import { Dependabot, DependabotOptions } from "./dependabot";
-import { GithubCredentials } from "./github-credentials";
-import { Mergify, MergifyOptions } from "./mergify";
-import { PullRequestTemplate } from "./pr-template";
-import { PullRequestLintOptions } from "./pull-request-lint";
-import { GithubWorkflow } from "./workflows";
-import { Component } from "../component";
-import { Project } from "../project";
-export interface GitHubOptions {
-    /**
-     * Whether mergify should be enabled on this repository or not.
-     *
-     * @default true
-     */
-    readonly mergify?: boolean;
-    /**
-     * Options for Mergify.
-     *
-     * @default - default options
-     */
-    readonly mergifyOptions?: MergifyOptions;
-    /**
-     * Enables GitHub workflows. If this is set to `false`, workflows will not be created.
-     *
-     * @default true
-     */
-    readonly workflows?: boolean;
-    /**
-     * Add a workflow that performs basic checks for pull requests, like
-     * validating that PRs follow Conventional Commits.
-     *
-     * @default true
-     */
-    readonly pullRequestLint?: boolean;
-    /**
-     * Options for configuring a pull request linter.
-     *
-     * @default - see defaults in `PullRequestLintOptions`
-     */
-    readonly pullRequestLintOptions?: PullRequestLintOptions;
-    /**
-     * Choose a method of providing GitHub API access for projen workflows.
-     *
-     * @default - use a personal access token named PROJEN_GITHUB_TOKEN
-     */
-    readonly projenCredentials?: GithubCredentials;
-    /**
-     * The name of a secret which includes a GitHub Personal Access Token to be
-     * used by projen workflows. This token needs to have the `repo`, `workflows`
-     * and `packages` scope.
-     *
-     * @default "PROJEN_GITHUB_TOKEN"
-     * @deprecated - use `projenCredentials`
-     */
-    readonly projenTokenSecret?: string;
-    /**
-     * Download files in LFS in workflows
-     *
-     * @default true if the associated project has `lfsPatterns`, `false` otherwise
-     */
-    readonly downloadLfs?: boolean;
-}
-export declare class GitHub extends Component {
-    /**
-     * Returns the `GitHub` component of a project or `undefined` if the project
-     * does not have a GitHub component.
-     */
-    static of(project: Project): GitHub | undefined;
-    /**
-     * The `Mergify` configured on this repository. This is `undefined` if Mergify
-     * was not enabled when creating the repository.
-     */
-    readonly mergify?: Mergify;
-    /**
-     * Are workflows enabled?
-     */
-    readonly workflowsEnabled: boolean;
-    /**
-     * GitHub API authentication method used by projen workflows.
-     */
-    readonly projenCredentials: GithubCredentials;
-    /**
-     *
-     */
-    readonly actions: GitHubActionsProvider;
-    private readonly _downloadLfs?;
-    constructor(project: Project, options?: GitHubOptions);
-    /**
-     * All workflows.
-     */
-    get workflows(): GithubWorkflow[];
-    /**
-     * Adds a workflow to the project.
-     * @param name Name of the workflow
-     * @returns a GithubWorkflow instance
-     */
-    addWorkflow(name: string): GithubWorkflow;
-    addPullRequestTemplate(...content: string[]): PullRequestTemplate;
-    addDependabot(options?: DependabotOptions): Dependabot;
-    /**
-     * Finds a GitHub workflow by name. Returns `undefined` if the workflow cannot be found.
-     * @param name The name of the GitHub workflow
-     */
-    tryFindWorkflow(name: string): undefined | GithubWorkflow;
-    /**
-     * Whether downloading from LFS is enabled for this GitHub project
-     */
-    get downloadLfs(): boolean;
-}

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

@@ -1,17 +0,0 @@
-export * from "./github";
-export * from "./dependabot";
-export * from "./workflows";
-export * from "./actions-provider";
-export * from "./mergify";
-export * from "./pr-template";
-export * from "./mergify";
-export * from "./auto-merge";
-export * from "./auto-approve";
-export * from "./stale";
-export * from "./pull-request-lint";
-export * from "./github-credentials";
-export * from "./workflow-actions";
-export * from "./workflow-jobs";
-export * from "./task-workflow";
-export * from "./github-project";
-export * as workflows from "./workflows-model";