projen 0.70.2 → 0.70.4

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

@@ -0,0 +1,338 @@
+import { Publisher } from "./publisher";
+import { ReleaseTrigger } from "./release-trigger";
+import { Component } from "../component";
+import { GitHubProject } from "../github";
+import { Job, JobPermissions, JobStep } from "../github/workflows-model";
+import { Task } from "../task";
+type BranchHook = (branch: string) => void;
+/**
+ * Project options for release.
+ */
+export interface ReleaseProjectOptions {
+    /**
+     * Automatically release new versions every commit to one of branches in `releaseBranches`.
+     *
+     * @default true
+     *
+     * @deprecated Use `releaseTrigger: ReleaseTrigger.continuous()` instead
+     */
+    readonly releaseEveryCommit?: boolean;
+    /**
+     * CRON schedule to trigger new releases.
+     *
+     * @default - no scheduled releases
+     *
+     * @deprecated Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
+     */
+    readonly releaseSchedule?: string;
+    /**
+     * The release trigger to use.
+     *
+     * @default - Continuous releases (`ReleaseTrigger.continuous()`)
+     */
+    readonly releaseTrigger?: ReleaseTrigger;
+    /**
+     * A set of workflow steps to execute in order to setup the workflow
+     * container.
+     */
+    readonly releaseWorkflowSetupSteps?: JobStep[];
+    /**
+     * Container image to use for GitHub workflows.
+     *
+     * @default - default image
+     */
+    readonly workflowContainerImage?: string;
+    /**
+     * Version requirement of `publib` which is used to publish modules to npm.
+     * @default "latest"
+     */
+    readonly jsiiReleaseVersion?: string;
+    /**
+     * Steps to execute after build as part of the release workflow.
+     * @default []
+     */
+    readonly postBuildSteps?: JobStep[];
+    /**
+     * Major version to release from the default branch.
+     *
+     * If this is specified, we bump the latest version of this major version line.
+     * If not specified, we bump the global latest version.
+     *
+     * @default - Major version is not enforced.
+     */
+    readonly majorVersion?: number;
+    /**
+     * Minimal Major version to release
+     *
+     *
+     * This can be useful to set to 1, as breaking changes before the 1.x major
+     * release are not incrementing the major version number.
+     *
+     * Can not be set together with `majorVersion`.
+     *
+     * @default - No minimum version is being enforced
+     */
+    readonly minMajorVersion?: number;
+    /**
+     * Bump versions from the default branch as pre-releases (e.g. "beta",
+     * "alpha", "pre").
+     *
+     * @default - normal semantic versions
+     */
+    readonly prerelease?: string;
+    /**
+     * The npmDistTag to use when publishing from the default branch.
+     *
+     * To set the npm dist-tag for release branches, set the `npmDistTag` property
+     * for each branch.
+     *
+     * @default "latest"
+     */
+    readonly npmDistTag?: string;
+    /**
+     * The name of the default release workflow.
+     *
+     * @default "Release"
+     */
+    readonly releaseWorkflowName?: string;
+    /**
+     * Defines additional release branches. A workflow will be created for each
+     * release branch which will publish releases from commits in this branch.
+     * Each release branch _must_ be assigned a major version number which is used
+     * to enforce that versions published from that branch always use that major
+     * version. If multiple branches are used, the `majorVersion` field must also
+     * be provided for the default branch.
+     *
+     * @default - no additional branches are used for release. you can use
+     * `addBranch()` to add additional branches.
+     */
+    readonly releaseBranches?: {
+        [name: string]: BranchOptions;
+    };
+    /**
+     * Create a github issue on every failed publishing task.
+     *
+     * @default false
+     */
+    readonly releaseFailureIssue?: boolean;
+    /**
+     * The label to apply to issues indicating publish failures.
+     * Only applies if `releaseFailureIssue` is true.
+     *
+     * @default "failed-release"
+     */
+    readonly releaseFailureIssueLabel?: string;
+    /**
+     * Automatically add the given prefix to release tags.
+     * Useful if you are releasing on multiple branches with overlapping
+     * version numbers.
+     *
+     * Note: this prefix is used to detect the latest tagged version
+     * when bumping, so if you change this on a project with an existing version
+     * history, you may need to manually tag your latest release
+     * with the new prefix.
+     *
+     * @default "v"
+     */
+    readonly releaseTagPrefix?: string;
+    /**
+     * Custom configuration used when creating changelog with standard-version package.
+     * Given values either append to default configuration or overwrite values in it.
+     *
+     * @default - standard configuration applicable for GitHub repositories
+     */
+    readonly versionrcOptions?: Record<string, any>;
+    /**
+     * Github Runner selection labels
+     * @default ["ubuntu-latest"]
+     */
+    readonly workflowRunsOn?: string[];
+    /**
+     * Define publishing tasks that can be executed manually as well as workflows.
+     *
+     * Normally, publishing only happens within automated workflows. Enable this
+     * in order to create a publishing task for each publishing activity.
+     *
+     * @default false
+     */
+    readonly publishTasks?: boolean;
+    /**
+     * Instead of actually publishing to package managers, just print the publishing command.
+     *
+     * @default false
+     */
+    readonly publishDryRun?: boolean;
+}
+/**
+ * Options for `Release`.
+ */
+export interface ReleaseOptions extends ReleaseProjectOptions {
+    /**
+     * The task to execute in order to create the release artifacts. Artifacts are
+     * expected to reside under `artifactsDirectory` (defaults to `dist/`) once
+     * build is complete.
+     */
+    readonly task: Task;
+    /**
+     * A name of a .json file to set the `version` field in after a bump.
+     *
+     * @example "package.json"
+     */
+    readonly versionFile: string;
+    /**
+     * The default branch name to release from.
+     *
+     * Use `majorVersion` to restrict this branch to only publish releases with a
+     * specific major version.
+     *
+     * You can add additional branches using `addBranch()`.
+     */
+    readonly branch: string;
+    /**
+     * Create a GitHub release for each release.
+     *
+     * @default true
+     */
+    readonly githubRelease?: boolean;
+    /**
+     * A directory which will contain build artifacts.
+     *
+     * @default "dist"
+     */
+    readonly artifactsDirectory: string;
+    /**
+     * Node version to setup in GitHub workflows if any node-based CLI utilities
+     * are needed. For example `publib`, the CLI projen uses to publish releases,
+     * is an npm library.
+     *
+     * @default 16.x
+     */
+    readonly workflowNodeVersion?: string;
+    /**
+     * Permissions granted to the release workflow job
+     * @default `{ contents: JobPermission.WRITE }`
+     */
+    readonly workflowPermissions?: JobPermissions;
+}
+/**
+ * Manages releases (currently through GitHub workflows).
+ *
+ * By default, no branches are released. To add branches, call `addBranch()`.
+ */
+export declare class Release extends Component {
+    static readonly ANTI_TAMPER_CMD = "git diff --ignore-space-at-eol --exit-code";
+    /**
+     * Returns the `Release` component of a project or `undefined` if the project
+     * does not have a Release component.
+     */
+    static of(project: GitHubProject): Release | undefined;
+    /**
+     * Package publisher.
+     */
+    readonly publisher: Publisher;
+    private readonly buildTask;
+    private readonly version;
+    private readonly postBuildSteps;
+    private readonly versionFile;
+    private readonly releaseTrigger;
+    private readonly preBuildSteps;
+    private readonly containerImage?;
+    private readonly _branches;
+    private readonly jobs;
+    private readonly defaultBranch;
+    private readonly github?;
+    private readonly workflowRunsOn?;
+    private readonly workflowPermissions;
+    private readonly _branchHooks;
+    /**
+     * Location of build artifacts.
+     */
+    readonly artifactsDirectory: string;
+    constructor(project: GitHubProject, options: ReleaseOptions);
+    /**
+     * Add a hook that should be run for every branch (including those that will
+     * be added by future `addBranch` calls).
+     * @internal
+     */
+    _forEachBranch(hook: BranchHook): void;
+    /**
+     * Adds a release branch.
+     *
+     * It is a git branch from which releases are published. If a project has more than one release
+     * branch, we require that `majorVersion` is also specified for the primary branch in order to
+     * ensure branches always release the correct version.
+     *
+     * @param branch The branch to monitor (e.g. `main`, `v2.x`)
+     * @param options Branch definition
+     */
+    addBranch(branch: string, options: BranchOptions): void;
+    /**
+     * Adds a release branch.
+     *
+     * It is a git branch from which releases are published. If a project has more than one release
+     * branch, we require that `majorVersion` is also specified for the primary branch in order to
+     * ensure branches always release the correct version.
+     *
+     * @param branch The branch to monitor (e.g. `main`, `v2.x`)
+     * @param options Branch definition
+     */
+    private _addBranch;
+    preSynthesize(): void;
+    /**
+     * Adds jobs to all release workflows.
+     * @param jobs The jobs to add (name => job)
+     */
+    addJobs(jobs: Record<string, Job>): void;
+    /**
+     * Retrieve all release branch names
+     */
+    get branches(): string[];
+    /**
+     * @returns a workflow or `undefined` if github integration is disabled.
+     */
+    private createWorkflow;
+}
+/**
+ * Options for a release branch.
+ */
+export interface BranchOptions {
+    /**
+     * The name of the release workflow.
+     * @default "release-BRANCH"
+     */
+    readonly workflowName?: string;
+    /**
+     * The major versions released from this branch.
+     */
+    readonly majorVersion: number;
+    /**
+     * The minimum major version to release.
+     */
+    readonly minMajorVersion?: number;
+    /**
+     * Bump the version as a pre-release tag.
+     *
+     * @default - normal releases
+     */
+    readonly prerelease?: string;
+    /**
+     * Automatically add the given prefix to release tags.
+     * Useful if you are releasing on multiple branches with overlapping
+     * version numbers.
+     *
+     * Note: this prefix is used to detect the latest tagged version
+     * when bumping, so if you change this on a project with an existing version
+     * history, you may need to manually tag your latest release
+     * with the new prefix.
+     *
+     * @default - no prefix
+     */
+    readonly tagPrefix?: string;
+    /**
+     * The npm distribution tag to use for this branch.
+     *
+     * @default "latest"
+     */
+    readonly npmDistTag?: string;
+}
+export {};

package/lib/.types-compat/ts3.9/lib/release/reset-version.task.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/.types-compat/ts3.9/lib/release/tag-version.d.ts

@@ -0,0 +1,31 @@
+export interface TagOptions {
+    /**
+     * Path to release tag file housing the release version.
+     *
+     * Relative to cwd.
+     *
+     * @example `dist/releaseTag.txt`
+     */
+    readonly releaseTagFile: string;
+    /**
+     * Path to release-specific changelog file.
+     *
+     * Relative to cwd.
+     *
+     * @example `dist/changelog.md`
+     */
+    readonly changelog: string;
+}
+/**
+ * Generate an annotated release tag using version and changelog files.
+ *
+ * The tag will be normalized to the format "v<version>" where version comes
+ * from the provided version file.
+ *
+ * The tag annotation message will be set to the content of the provided release
+ * changelog file.
+ *
+ * @param cwd working directory (git repository)
+ * @param options options
+ */
+export declare function tag(cwd: string, options: TagOptions): Promise<void>;

package/lib/.types-compat/ts3.9/lib/release/tag-version.task.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/.types-compat/ts3.9/lib/release/update-changelog.d.ts

@@ -0,0 +1,36 @@
+export interface UpdateChangelogOptions {
+    /**
+     * Path to input changelog entry file.
+     *
+     * Relative to cwd.
+     *
+     * @example dist/changelog.md
+     */
+    inputChangelog: string;
+    /**
+     * Path to project-level changelog.
+     *
+     * The contents of inputChangelog will be prepended onto
+     * this changelog.
+     *
+     * Relative to cwd
+     *
+     * @example changelog.md
+     */
+    outputChangelog: string;
+    /**
+     * Release version.
+     */
+    versionFile: string;
+}
+/**
+ * Prepends input changelog entry onto project-level changelog.
+ *
+ * Currently assumes a headerless changelog formatted according to
+ * [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
+ * rules.
+ *
+ * @param cwd working directory (git repository)
+ * @param options options
+ */
+export declare function updateChangelog(cwd: string, options: UpdateChangelogOptions): Promise<void>;

package/lib/.types-compat/ts3.9/lib/release/update-changelog.task.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,99 @@
+import { Component } from "./component";
+import { Project } from "./project";
+/**
+ * Options for Renovatebot
+ */
+export interface RenovatebotOptions {
+    /**
+     * How often to check for new versions and raise pull requests.
+     *
+     * Can be given in CRON or LATER format, and use multiple schedules
+     * (e.g. different for weekdays and weekends). Multiple rules are
+     * handles as OR.
+     *
+     * Some normal scheduling values defined in enum `RenovatebotScheduleInterval`.
+     *
+     * @see https://docs.renovatebot.com/configuration-options/#schedule
+     * @default ["at any time"]
+     */
+    readonly scheduleInterval?: string[];
+    /**
+     * You can use the `ignore` option to customize which dependencies are updated.
+     * The ignore option supports just package name.
+     * @default []
+     */
+    readonly ignore?: string[];
+    /**
+     * 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[];
+    readonly overrideConfig?: any;
+    readonly marker?: boolean;
+}
+/**
+ * How often to check for new versions and raise pull requests for version
+ * updates.
+ *
+ * @see https://docs.renovatebot.com/presets-schedule/
+ */
+export declare enum RenovatebotScheduleInterval {
+    /**
+     * Run at any time
+     */
+    ANY_TIME = "at any time",
+    /**
+     * Weekly schedule on early monday mornings
+     */
+    EARLY_MONDAYS = "before 3am on Monday",
+    /**
+     * Schedule daily
+     */
+    DAILY = "before 2am",
+    /**
+     * Schedule weekly
+     */
+    WEEKLY = "before 3am on Monday",
+    /**
+     * Schedule monthly
+     */
+    MONTHLY = "before 3am on the first day of the month",
+    /**
+     * Schedule quarterly
+     */
+    QUARTERLY = "every 3 months on the first day of the month",
+    /**
+     * Schedule for weekends
+     */
+    WEEKENDS = "every weekend",
+    /**
+     * Schedule for weekdays
+     */
+    WEEKDAYS = "every weekday"
+}
+/**
+ * Defines renovatebot configuration for projen project.
+ *
+ * Ignores the versions controlled by Projen.
+ */
+export declare class Renovatebot extends Component {
+    private readonly _project;
+    private readonly explicitIgnores;
+    private readonly scheduleInterval;
+    private readonly labels?;
+    private readonly marker?;
+    private readonly overrideConfig?;
+    constructor(project: Project, options?: RenovatebotOptions);
+    preSynthesize(): void;
+    private createRenovateConfiguration;
+}

package/lib/.types-compat/ts3.9/lib/run-projenrc-json.task.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/.types-compat/ts3.9/lib/sample-file.d.ts

@@ -0,0 +1,88 @@
+import { Component } from "./component";
+import { Project } from "./project";
+/**
+ * Options for the SampleFile object.
+ */
+export interface SampleFileOptions {
+    /**
+     * The contents of the file to write.
+     */
+    readonly contents?: string;
+    /**
+     * Absolute path to a file to copy the contents from (does not need to be
+     * a text file).
+     *
+     * If your project is Typescript-based and has configured `testdir` to be a
+     * subdirectory of `src`, sample files should outside of the `src` directory,
+     * otherwise they may not be copied. For example:
+     * ```
+     * new SampleFile(this, 'assets/icon.png', { source: path.join(__dirname, '..', 'sample-assets', 'icon.png') });
+     * ```
+     */
+    readonly sourcePath?: string;
+}
+/**
+ * Produces a file with the given contents but only once, if the file doesn't already exist.
+ * Use this for creating example code files or other resources.
+ */
+export declare class SampleFile extends Component {
+    private readonly filePath;
+    private readonly options;
+    /**
+     * Creates a new SampleFile object
+     * @param project - the project to tie this file to.
+     * @param filePath - the relative path in the project to put the file
+     * @param options - the options for the file.
+     */
+    constructor(project: Project, filePath: string, options: SampleFileOptions);
+    synthesize(): void;
+    /**
+     * A helper function that will write the file once and return if it was written or not.
+     * @param dir - the directory for the new file
+     * @param filename - the filename for the new file
+     * @param contents - the contents of the file to write
+     * @return boolean - whether a new file was written or not.
+     * @private
+     */
+    private writeOnceFileContents;
+}
+/**
+ * SampleDir options
+ */
+export interface SampleDirOptions {
+    /**
+     * The files to render into the directory. These files get added after
+     * any files from `source` if that option is specified (replacing if names
+     * overlap).
+     */
+    readonly files?: {
+        [fileName: string]: string;
+    };
+    /**
+     * Absolute path to a directory to copy files from (does not need to be text
+     * files).
+     *
+     * If your project is typescript-based and has configured `testdir` to be a
+     * subdirectory of `src`, sample files should outside of the `src` directory
+     * otherwise they may not be copied. For example:
+     * ```
+     * new SampleDir(this, 'public', { source: path.join(__dirname, '..', 'sample-assets') });
+     * ```
+     */
+    readonly sourceDir?: string;
+}
+/**
+ * Renders the given files into the directory if the directory does not exist. Use this to create sample code files
+ */
+export declare class SampleDir extends Component {
+    private readonly dir;
+    private readonly options;
+    /**
+     * Create sample files in the given directory if the given directory does not exist
+     * @param project Parent project to add files to.
+     * @param dir directory to add files to. If directory already exists, nothing is added.
+     * @param options options for which files to create.
+     */
+    constructor(project: Project, dir: string, options: SampleDirOptions);
+    synthesize(): void;
+}

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

@@ -0,0 +1,34 @@
+/**
+ * @deprecated This class will be removed in upcoming releases. if you wish to
+ * specify semver requirements in `deps`, `devDeps`, etc, specify them like so
+ * `express@^2.1`.
+ */
+export declare class Semver {
+    readonly spec: string;
+    static of(spec: string): Semver;
+    /**
+     * Latest version.
+     */
+    static latest(): Semver;
+    /**
+     * Accept only an exact version
+     */
+    static pinned(version: string): Semver;
+    /**
+     * Accept any minor version.
+     *
+     * >= version
+     * < next major version
+     */
+    static caret(version: string): Semver;
+    /**
+     * Accept patches.
+     *
+     * >= version
+     * < next minor version
+     */
+    static tilde(version: string): Semver;
+    readonly mode?: string;
+    private constructor();
+    get version(): string | undefined;
+}