Package io.github.cdklabs.projen.cdk8s

Class ConstructLibraryCdk8s.Builder

    • Method Detail

      • name

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder name​(String name)
        (experimental) This is the name of your project.

        Default: $BASEDIR

        Parameters:
        name - This is the name of your project. This parameter is required.
        Returns:
        this

      • commitGenerated

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder commitGenerated​(Boolean commitGenerated)
        (experimental) Whether to commit the managed files by default.

        Default: true

        Parameters:
        commitGenerated - Whether to commit the managed files by default. This parameter is required.
        Returns:
        this

      • gitIgnoreOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder gitIgnoreOptions​(IgnoreFileOptions gitIgnoreOptions)
        (experimental) Configuration options for .gitignore file.

        Parameters:
        gitIgnoreOptions - Configuration options for .gitignore file. This parameter is required.
        Returns:
        this

      • gitOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder gitOptions​(GitOptions gitOptions)
        (experimental) Configuration options for git.

        Parameters:
        gitOptions - Configuration options for git. This parameter is required.
        Returns:
        this

      • logging

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder logging​(LoggerOptions logging)
        (experimental) Configure logging options such as verbosity.

        Default: {}

        Parameters:
        logging - Configure logging options such as verbosity. This parameter is required.
        Returns:
        this

      • outdir

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder outdir​(String outdir)
        (experimental) The root directory of the project.

        Relative to this directory, all files are synthesized.

        If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

        Default: "."

        Parameters:
        outdir - The root directory of the project. This parameter is required.
        Returns:
        this

      • parent

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder parent​(Project parent)
        (experimental) The parent project, if this project is part of a bigger project.

        Parameters:
        parent - The parent project, if this project is part of a bigger project. This parameter is required.
        Returns:
        this

      • projenCommand

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenCommand​(String projenCommand)
        (experimental) The shell command to use in order to run the projen CLI.

        Can be used to customize in special environments.

        Default: "npx projen"

        Parameters:
        projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.
        Returns:
        this

      • projenrcJson

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenrcJson​(Boolean projenrcJson)
        (experimental) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

        Default: false

        Parameters:
        projenrcJson - Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. This parameter is required.
        Returns:
        this

      • projenrcJsonOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenrcJsonOptions​(ProjenrcJsonOptions projenrcJsonOptions)
        (experimental) Options for .projenrc.json.

        Default: - default options

        Parameters:
        projenrcJsonOptions - Options for .projenrc.json. This parameter is required.
        Returns:
        this

      • renovatebot

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder renovatebot​(Boolean renovatebot)
        (experimental) Use renovatebot to handle dependency upgrades.

        Default: false

        Parameters:
        renovatebot - Use renovatebot to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • renovatebotOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder renovatebotOptions​(RenovatebotOptions renovatebotOptions)
        (experimental) Options for renovatebot.

        Default: - default options

        Parameters:
        renovatebotOptions - Options for renovatebot. This parameter is required.
        Returns:
        this

      • autoApproveOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder autoApproveOptions​(AutoApproveOptions autoApproveOptions)
        (experimental) Enable and configure the 'auto approve' workflow.

        Default: - auto approve is disabled

        Parameters:
        autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.
        Returns:
        this

      • autoMerge

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder autoMerge​(Boolean autoMerge)
        (experimental) Enable automatic merging on GitHub.

        Has no effect if github.mergify is set to false.

        Default: true

        Parameters:
        autoMerge - Enable automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • autoMergeOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder autoMergeOptions​(AutoMergeOptions autoMergeOptions)
        (experimental) Configure options for automatic merging on GitHub.

        Has no effect if github.mergify or autoMerge is set to false.

        Default: - see defaults in `AutoMergeOptions`

        Parameters:
        autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.
        Returns:
        this

      • clobber

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder clobber​(Boolean clobber)
        (experimental) Add a clobber task which resets the repo to origin.

        Default: - true, but false for subprojects

        Parameters:
        clobber - Add a clobber task which resets the repo to origin. This parameter is required.
        Returns:
        this

      • devContainer

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder devContainer​(Boolean devContainer)
        (experimental) Add a VSCode development environment (used for GitHub Codespaces).

        Default: false

        Parameters:
        devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.
        Returns:
        this

      • github

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder github​(Boolean github)
        (experimental) Enable GitHub integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        github - Enable GitHub integration. This parameter is required.
        Returns:
        this

      • githubOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder githubOptions​(GitHubOptions githubOptions)
        (experimental) Options for GitHub integration.

        Default: - see GitHubOptions

        Parameters:
        githubOptions - Options for GitHub integration. This parameter is required.
        Returns:
        this

      • gitpod

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder gitpod​(Boolean gitpod)
        (experimental) Add a Gitpod development environment.

        Default: false

        Parameters:
        gitpod - Add a Gitpod development environment. This parameter is required.
        Returns:
        this

      • mergify

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder mergify​(Boolean mergify)
        Deprecated.
        use githubOptions.mergify instead
        (deprecated) Whether mergify should be enabled on this repository or not.

        Default: true

        Parameters:
        mergify - Whether mergify should be enabled on this repository or not. This parameter is required.
        Returns:
        this

      • mergifyOptions

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder mergifyOptions​(MergifyOptions mergifyOptions)
        Deprecated.
        use githubOptions.mergifyOptions instead
        (deprecated) Options for mergify.

        Default: - default options

        Parameters:
        mergifyOptions - Options for mergify. This parameter is required.
        Returns:
        this

      • projectType

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder projectType​(ProjectType projectType)
        Deprecated.
        no longer supported at the base project level
        (deprecated) Which type of project this is (library/app).

        Default: ProjectType.UNKNOWN

        Parameters:
        projectType - Which type of project this is (library/app). This parameter is required.
        Returns:
        this

      • projenCredentials

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenCredentials​(GithubCredentials projenCredentials)
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

        Parameters:
        projenCredentials - Choose a method of providing GitHub API access for projen workflows. This parameter is required.
        Returns:
        this

      • projenTokenSecret

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder projenTokenSecret​(String projenTokenSecret)
        Deprecated.
        use projenCredentials
        (deprecated) 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"

        Parameters:
        projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This parameter is required.
        Returns:
        this

      • readme

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder readme​(SampleReadmeProps readme)
        (experimental) The README setup.

        Default: - { filename: 'README.md', contents: '# replace this' }

        Example: 

         "{ filename: 'readme.md', contents: '# title' }"

        Parameters:
        readme - The README setup. This parameter is required.
        Returns:
        this

      • stale

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder stale​(Boolean stale)
        (experimental) Auto-close of stale issues and pull request.

        See staleOptions for options.

        Default: false

        Parameters:
        stale - Auto-close of stale issues and pull request. This parameter is required.
        Returns:
        this

      • staleOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder staleOptions​(StaleOptions staleOptions)
        (experimental) Auto-close stale issues and pull requests.

        To disable set stale to false.

        Default: - see defaults in `StaleOptions`

        Parameters:
        staleOptions - Auto-close stale issues and pull requests. This parameter is required.
        Returns:
        this

      • vscode

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder vscode​(Boolean vscode)
        (experimental) Enable VSCode integration.

        Enabled by default for root projects. Disabled for non-root projects.

        Default: true

        Parameters:
        vscode - Enable VSCode integration. This parameter is required.
        Returns:
        this

      • allowLibraryDependencies

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder allowLibraryDependencies​(Boolean allowLibraryDependencies)
        (experimental) Allow the project to include peerDependencies and bundledDependencies.

        This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

        Default: true

        Parameters:
        allowLibraryDependencies - Allow the project to include peerDependencies and bundledDependencies. This parameter is required.
        Returns:
        this

      • authorEmail

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder authorEmail​(String authorEmail)
        (experimental) Author's e-mail.

        Parameters:
        authorEmail - Author's e-mail. This parameter is required.
        Returns:
        this

      • authorName

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder authorName​(String authorName)
        (experimental) Author's name.

        Parameters:
        authorName - Author's name. This parameter is required.
        Returns:
        this

      • authorOrganization

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder authorOrganization​(Boolean authorOrganization)
        (experimental) Is the author an organization.

        Parameters:
        authorOrganization - Is the author an organization. This parameter is required.
        Returns:
        this

      • authorUrl

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder authorUrl​(String authorUrl)
        (experimental) Author's URL / Website.

        Parameters:
        authorUrl - Author's URL / Website. This parameter is required.
        Returns:
        this

      • autoDetectBin

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder autoDetectBin​(Boolean autoDetectBin)
        (experimental) Automatically add all executables under the bin directory to your package.json file under the bin section.

        Default: true

        Parameters:
        autoDetectBin - Automatically add all executables under the bin directory to your package.json file under the bin section. This parameter is required.
        Returns:
        this

      • bin

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder bin​(Map<String,​String> bin)
        (experimental) Binary programs vended with your module.

        You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

        Parameters:
        bin - Binary programs vended with your module. This parameter is required.
        Returns:
        this

      • bugsEmail

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder bugsEmail​(String bugsEmail)
        (experimental) The email address to which issues should be reported.

        Parameters:
        bugsEmail - The email address to which issues should be reported. This parameter is required.
        Returns:
        this

      • bugsUrl

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder bugsUrl​(String bugsUrl)
        (experimental) The url to your project's issue tracker.

        Parameters:
        bugsUrl - The url to your project's issue tracker. This parameter is required.
        Returns:
        this

      • bundledDeps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder bundledDeps​(List<String> bundledDeps)
        (experimental) List of dependencies to bundle into this module.

        These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

        The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

        Parameters:
        bundledDeps - List of dependencies to bundle into this module. This parameter is required.
        Returns:
        this

      • codeArtifactOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder codeArtifactOptions​(CodeArtifactOptions codeArtifactOptions)
        (experimental) Options for npm packages using AWS CodeArtifact.

        This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

        Default: - undefined

        Parameters:
        codeArtifactOptions - Options for npm packages using AWS CodeArtifact. This parameter is required.
        Returns:
        this

      • deps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder deps​(List<String> deps)
        (experimental) Runtime dependencies of this module.

        The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

        Default: []

        Example: 

         [ 'express', 'lodash', 'foo@^2' ]

        Parameters:
        deps - Runtime dependencies of this module. This parameter is required.
        Returns:
        this

      • description

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder description​(String description)
        (experimental) The description is just a string that helps people understand the purpose of the package.

        It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description

        Parameters:
        description - The description is just a string that helps people understand the purpose of the package. This parameter is required.
        Returns:
        this

      • devDeps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder devDeps​(List<String> devDeps)
        (experimental) Build dependencies for this module.

        These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

        The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

        Default: []

        Example: 

         [ 'typescript', '@types/express' ]

        Parameters:
        devDeps - Build dependencies for this module. This parameter is required.
        Returns:
        this

      • entrypoint

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder entrypoint​(String entrypoint)
        (experimental) Module entrypoint (main in package.json).

        Set to an empty string to not include main in your package.json

        Default: "lib/index.js"

        Parameters:
        entrypoint - Module entrypoint (main in package.json). This parameter is required.
        Returns:
        this

      • homepage

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder homepage​(String homepage)
        (experimental) Package's Homepage / Website.

        Parameters:
        homepage - Package's Homepage / Website. This parameter is required.
        Returns:
        this

      • keywords

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder keywords​(List<String> keywords)
        (experimental) Keywords to include in package.json.

        Parameters:
        keywords - Keywords to include in package.json. This parameter is required.
        Returns:
        this

      • license

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder license​(String license)
        (experimental) License's SPDX identifier.

        See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

        Default: "Apache-2.0"

        Parameters:
        license - License's SPDX identifier. This parameter is required.
        Returns:
        this

      • licensed

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder licensed​(Boolean licensed)
        (experimental) Indicates if a license should be added.

        Default: true

        Parameters:
        licensed - Indicates if a license should be added. This parameter is required.
        Returns:
        this

      • maxNodeVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder maxNodeVersion​(String maxNodeVersion)
        (experimental) Minimum node.js version to require via engines (inclusive).

        Default: - no max

        Parameters:
        maxNodeVersion - Minimum node.js version to require via engines (inclusive). This parameter is required.
        Returns:
        this

      • minNodeVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder minNodeVersion​(String minNodeVersion)
        (experimental) Minimum Node.js version to require via package.json engines (inclusive).

        Default: - no "engines" specified

        Parameters:
        minNodeVersion - Minimum Node.js version to require via package.json engines (inclusive). This parameter is required.
        Returns:
        this

      • npmAccess

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmAccess​(NpmAccess npmAccess)
        (experimental) Access level of the npm package.

        Default: - for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.

        Parameters:
        npmAccess - Access level of the npm package. This parameter is required.
        Returns:
        this

      • npmProvenance

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmProvenance​(Boolean npmProvenance)
        (experimental) Should provenance statements be generated when the package is published.

        A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

        Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

        Default: - true for public packages, false otherwise

        Parameters:
        npmProvenance - Should provenance statements be generated when the package is published. This parameter is required.
        Returns:
        this
        See Also:
        https://docs.npmjs.com/generating-provenance-statements

      • npmRegistry

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder npmRegistry​(String npmRegistry)
        Deprecated.
        use npmRegistryUrl instead
        (deprecated) The host name of the npm registry to publish to.

        Cannot be set together with npmRegistryUrl.

        Parameters:
        npmRegistry - The host name of the npm registry to publish to. This parameter is required.
        Returns:
        this

      • npmRegistryUrl

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmRegistryUrl​(String npmRegistryUrl)
        (experimental) The base URL of the npm package registry.

        Must be a URL (e.g. start with "https://" or "http://")

        Default: "https://registry.npmjs.org"

        Parameters:
        npmRegistryUrl - The base URL of the npm package registry. This parameter is required.
        Returns:
        this

      • npmTokenSecret

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmTokenSecret​(String npmTokenSecret)
        (experimental) GitHub secret which contains the NPM token to use when publishing packages.

        Default: "NPM_TOKEN"

        Parameters:
        npmTokenSecret - GitHub secret which contains the NPM token to use when publishing packages. This parameter is required.
        Returns:
        this

      • packageManager

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder packageManager​(NodePackageManager packageManager)
        (experimental) The Node Package Manager used to execute scripts.

        Default: NodePackageManager.YARN_CLASSIC

        Parameters:
        packageManager - The Node Package Manager used to execute scripts. This parameter is required.
        Returns:
        this

      • packageName

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder packageName​(String packageName)
        (experimental) The "name" in package.json.

        Default: - defaults to project name

        Parameters:
        packageName - The "name" in package.json. This parameter is required.
        Returns:
        this

      • peerDependencyOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder peerDependencyOptions​(PeerDependencyOptions peerDependencyOptions)
        (experimental) Options for peerDeps.

        Parameters:
        peerDependencyOptions - Options for peerDeps. This parameter is required.
        Returns:
        this

      • peerDeps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder peerDeps​(List<String> peerDeps)
        (experimental) Peer dependencies for this module.

        Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

        Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.

        Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

        Default: []

        Parameters:
        peerDeps - Peer dependencies for this module. This parameter is required.
        Returns:
        this

      • pnpmVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder pnpmVersion​(String pnpmVersion)
        (experimental) The version of PNPM to use if using PNPM as a package manager.

        Default: "7"

        Parameters:
        pnpmVersion - The version of PNPM to use if using PNPM as a package manager. This parameter is required.
        Returns:
        this

      • repository

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder repository​(String repository)
        (experimental) The repository is the location where the actual code for your package lives.

        See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

        Parameters:
        repository - The repository is the location where the actual code for your package lives. This parameter is required.
        Returns:
        this

      • repositoryDirectory

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder repositoryDirectory​(String repositoryDirectory)
        (experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.

        Parameters:
        repositoryDirectory - If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. This parameter is required.
        Returns:
        this

      • scopedPackagesOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder scopedPackagesOptions​(List<? extends ScopedPackagesOptions> scopedPackagesOptions)
        (experimental) Options for privately hosted scoped packages.

        Default: - fetch all scoped packages from the public npm registry

        Parameters:
        scopedPackagesOptions - Options for privately hosted scoped packages. This parameter is required.
        Returns:
        this

      • scripts

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder scripts​(Map<String,​String> scripts)
        Deprecated.
        use project.addTask() or package.setScript()
        (deprecated) npm scripts to include.

        If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.

        Default: {}

        Parameters:
        scripts - npm scripts to include. This parameter is required.
        Returns:
        this

      • stability

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder stability​(String stability)
        (experimental) Package's Stability.

        Parameters:
        stability - Package's Stability. This parameter is required.
        Returns:
        this

      • yarnBerryOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder yarnBerryOptions​(YarnBerryOptions yarnBerryOptions)
        (experimental) Options for Yarn Berry.

        Default: - Yarn Berry v4 with all default options

        Parameters:
        yarnBerryOptions - Options for Yarn Berry. This parameter is required.
        Returns:
        this

      • jsiiReleaseVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder jsiiReleaseVersion​(String jsiiReleaseVersion)
        (experimental) Version requirement of publib which is used to publish modules to npm.

        Default: "latest"

        Parameters:
        jsiiReleaseVersion - Version requirement of publib which is used to publish modules to npm. This parameter is required.
        Returns:
        this

      • majorVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder majorVersion​(Number majorVersion)
        (experimental) 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.

        Parameters:
        majorVersion - Major version to release from the default branch. This parameter is required.
        Returns:
        this

      • minMajorVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder minMajorVersion​(Number minMajorVersion)
        (experimental) 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

        Parameters:
        minMajorVersion - Minimal Major version to release. This parameter is required.
        Returns:
        this

      • npmDistTag

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmDistTag​(String npmDistTag)
        (experimental) 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"

        Parameters:
        npmDistTag - The npmDistTag to use when publishing from the default branch. This parameter is required.
        Returns:
        this

      • postBuildSteps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder postBuildSteps​(List<? extends JobStep> postBuildSteps)
        (experimental) Steps to execute after build as part of the release workflow.

        Default: []

        Parameters:
        postBuildSteps - Steps to execute after build as part of the release workflow. This parameter is required.
        Returns:
        this

      • prerelease

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder prerelease​(String prerelease)
        (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

        Default: - normal semantic versions

        Parameters:
        prerelease - Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). This parameter is required.
        Returns:
        this

      • publishDryRun

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder publishDryRun​(Boolean publishDryRun)
        (experimental) Instead of actually publishing to package managers, just print the publishing command.

        Default: false

        Parameters:
        publishDryRun - Instead of actually publishing to package managers, just print the publishing command. This parameter is required.
        Returns:
        this

      • publishTasks

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder publishTasks​(Boolean publishTasks)
        (experimental) 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

        Parameters:
        publishTasks - Define publishing tasks that can be executed manually as well as workflows. This parameter is required.
        Returns:
        this

      • releasableCommits

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releasableCommits​(ReleasableCommits releasableCommits)
        (experimental) Find commits that should be considered releasable Used to decide if a release is required.

        Default: ReleasableCommits.everyCommit()

        Parameters:
        releasableCommits - Find commits that should be considered releasable Used to decide if a release is required. This parameter is required.
        Returns:
        this

      • releaseBranches

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseBranches​(Map<String,​? extends BranchOptions> releaseBranches)
        (experimental) 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.

        Parameters:
        releaseBranches - Defines additional release branches. This parameter is required.
        Returns:
        this

      • releaseEveryCommit

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder releaseEveryCommit​(Boolean releaseEveryCommit)
        Deprecated.
        Use releaseTrigger: ReleaseTrigger.continuous() instead
        (deprecated) Automatically release new versions every commit to one of branches in releaseBranches.

        Default: true

        Parameters:
        releaseEveryCommit - Automatically release new versions every commit to one of branches in releaseBranches. This parameter is required.
        Returns:
        this

      • releaseFailureIssue

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseFailureIssue​(Boolean releaseFailureIssue)
        (experimental) Create a github issue on every failed publishing task.

        Default: false

        Parameters:
        releaseFailureIssue - Create a github issue on every failed publishing task. This parameter is required.
        Returns:
        this

      • releaseFailureIssueLabel

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseFailureIssueLabel​(String releaseFailureIssueLabel)
        (experimental) The label to apply to issues indicating publish failures.

        Only applies if releaseFailureIssue is true.

        Default: "failed-release"

        Parameters:
        releaseFailureIssueLabel - The label to apply to issues indicating publish failures. This parameter is required.
        Returns:
        this

      • releaseSchedule

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder releaseSchedule​(String releaseSchedule)
        Deprecated.
        Use releaseTrigger: ReleaseTrigger.scheduled() instead
        (deprecated) CRON schedule to trigger new releases.

        Default: - no scheduled releases

        Parameters:
        releaseSchedule - CRON schedule to trigger new releases. This parameter is required.
        Returns:
        this

      • releaseTagPrefix

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseTagPrefix​(String releaseTagPrefix)
        (experimental) 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"

        Parameters:
        releaseTagPrefix - Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. This parameter is required.
        Returns:
        this

      • releaseTrigger

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseTrigger​(ReleaseTrigger releaseTrigger)
        (experimental) The release trigger to use.

        Default: - Continuous releases (`ReleaseTrigger.continuous()`)

        Parameters:
        releaseTrigger - The release trigger to use. This parameter is required.
        Returns:
        this

      • releaseWorkflowName

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseWorkflowName​(String releaseWorkflowName)
        (experimental) The name of the default release workflow.

        Default: "release"

        Parameters:
        releaseWorkflowName - The name of the default release workflow. This parameter is required.
        Returns:
        this

      • releaseWorkflowSetupSteps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseWorkflowSetupSteps​(List<? extends JobStep> releaseWorkflowSetupSteps)
        (experimental) A set of workflow steps to execute in order to setup the workflow container.

        Parameters:
        releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container. This parameter is required.
        Returns:
        this

      • versionrcOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder versionrcOptions​(Map<String,​? extends Object> versionrcOptions)
        (experimental) 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

        Parameters:
        versionrcOptions - Custom configuration used when creating changelog with standard-version package. This parameter is required.
        Returns:
        this

      • workflowContainerImage

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowContainerImage​(String workflowContainerImage)
        (experimental) Container image to use for GitHub workflows.

        Default: - default image

        Parameters:
        workflowContainerImage - Container image to use for GitHub workflows. This parameter is required.
        Returns:
        this

      • workflowRunsOn

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowRunsOn​(List<String> workflowRunsOn)
        (experimental) Github Runner selection labels.

        Default: ["ubuntu-latest"]

        Parameters:
        workflowRunsOn - Github Runner selection labels. This parameter is required.
        Returns:
        this

      • workflowRunsOnGroup

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowRunsOnGroup​(GroupRunnerOptions workflowRunsOnGroup)
        (experimental) Github Runner Group selection options.

        Parameters:
        workflowRunsOnGroup - Github Runner Group selection options. This parameter is required.
        Returns:
        this

      • defaultReleaseBranch

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder defaultReleaseBranch​(String defaultReleaseBranch)
        (experimental) The name of the main release branch.

        Default: "main"

        Parameters:
        defaultReleaseBranch - The name of the main release branch. This parameter is required.
        Returns:
        this

      • artifactsDirectory

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder artifactsDirectory​(String artifactsDirectory)
        (experimental) A directory which will contain build artifacts.

        Default: "dist"

        Parameters:
        artifactsDirectory - A directory which will contain build artifacts. This parameter is required.
        Returns:
        this

      • autoApproveUpgrades

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder autoApproveUpgrades​(Boolean autoApproveUpgrades)
        (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

        Throw if set to true but autoApproveOptions are not defined.

        Default: - true

        Parameters:
        autoApproveUpgrades - Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.
        Returns:
        this

      • buildWorkflow

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder buildWorkflow​(Boolean buildWorkflow)
        (experimental) Define a GitHub workflow for building PRs.

        Default: - true if not a subproject

        Parameters:
        buildWorkflow - Define a GitHub workflow for building PRs. This parameter is required.
        Returns:
        this

      • buildWorkflowTriggers

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder buildWorkflowTriggers​(Triggers buildWorkflowTriggers)
        (experimental) Build workflow triggers.

        Default: "{ pullRequest: {}, workflowDispatch: {} }"

        Parameters:
        buildWorkflowTriggers - Build workflow triggers. This parameter is required.
        Returns:
        this

      • bundlerOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder bundlerOptions​(BundlerOptions bundlerOptions)
        (experimental) Options for Bundler.

        Parameters:
        bundlerOptions - Options for Bundler. This parameter is required.
        Returns:
        this

      • checkLicenses

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder checkLicenses​(LicenseCheckerOptions checkLicenses)
        (experimental) Configure which licenses should be deemed acceptable for use by dependencies.

        This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.

        Default: - no license checks are run during the build and all licenses will be accepted

        Parameters:
        checkLicenses - Configure which licenses should be deemed acceptable for use by dependencies. This parameter is required.
        Returns:
        this

      • codeCov

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder codeCov​(Boolean codeCov)
        (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret.

        Default: false

        Parameters:
        codeCov - Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret. This parameter is required.
        Returns:
        this

      • codeCovTokenSecret

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder codeCovTokenSecret​(String codeCovTokenSecret)
        (experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.

        Default: - if this option is not specified, only public repositories are supported

        Parameters:
        codeCovTokenSecret - Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. This parameter is required.
        Returns:
        this

      • copyrightOwner

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder copyrightOwner​(String copyrightOwner)
        (experimental) License copyright owner.

        Default: - defaults to the value of authorName or "" if `authorName` is undefined.

        Parameters:
        copyrightOwner - License copyright owner. This parameter is required.
        Returns:
        this

      • copyrightPeriod

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder copyrightPeriod​(String copyrightPeriod)
        (experimental) The copyright years to put in the LICENSE file.

        Default: - current year

        Parameters:
        copyrightPeriod - The copyright years to put in the LICENSE file. This parameter is required.
        Returns:
        this

      • dependabot

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder dependabot​(Boolean dependabot)
        (experimental) Use dependabot to handle dependency upgrades.

        Cannot be used in conjunction with depsUpgrade.

        Default: false

        Parameters:
        dependabot - Use dependabot to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • dependabotOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder dependabotOptions​(DependabotOptions dependabotOptions)
        (experimental) Options for dependabot.

        Default: - default options

        Parameters:
        dependabotOptions - Options for dependabot. This parameter is required.
        Returns:
        this

      • depsUpgrade

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder depsUpgrade​(Boolean depsUpgrade)
        (experimental) Use tasks and github workflows to handle dependency upgrades.

        Cannot be used in conjunction with dependabot.

        Default: true

        Parameters:
        depsUpgrade - Use tasks and github workflows to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • depsUpgradeOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder depsUpgradeOptions​(UpgradeDependenciesOptions depsUpgradeOptions)
        (experimental) Options for UpgradeDependencies.

        Default: - default options

        Parameters:
        depsUpgradeOptions - Options for UpgradeDependencies. This parameter is required.
        Returns:
        this

      • gitignore

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder gitignore​(List<String> gitignore)
        (experimental) Additional entries to .gitignore.

        Parameters:
        gitignore - Additional entries to .gitignore. This parameter is required.
        Returns:
        this

      • jest

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder jest​(Boolean jest)
        (experimental) Setup jest unit tests.

        Default: true

        Parameters:
        jest - Setup jest unit tests. This parameter is required.
        Returns:
        this

      • jestOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder jestOptions​(JestOptions jestOptions)
        (experimental) Jest options.

        Default: - default options

        Parameters:
        jestOptions - Jest options. This parameter is required.
        Returns:
        this

      • mutableBuild

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder mutableBuild​(Boolean mutableBuild)
        (experimental) Automatically update files modified during builds to pull-request branches.

        This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

        Implies that PR builds do not have anti-tamper checks.

        Default: true

        Parameters:
        mutableBuild - Automatically update files modified during builds to pull-request branches. This parameter is required.
        Returns:
        this

      • npmignore

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder npmignore​(List<String> npmignore)
        Deprecated.
        • use project.addPackageIgnore
        (deprecated) Additional entries to .npmignore.

        Parameters:
        npmignore - Additional entries to .npmignore. This parameter is required.
        Returns:
        this

      • npmignoreEnabled

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmignoreEnabled​(Boolean npmignoreEnabled)
        (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

        Default: true

        Parameters:
        npmignoreEnabled - Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. This parameter is required.
        Returns:
        this

      • npmIgnoreOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder npmIgnoreOptions​(IgnoreFileOptions npmIgnoreOptions)
        (experimental) Configuration options for .npmignore file.

        Parameters:
        npmIgnoreOptions - Configuration options for .npmignore file. This parameter is required.
        Returns:
        this

      • packageValue

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder packageValue​(Boolean packageValue)
        (experimental) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

        Default: true

        Parameters:
        packageValue - Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist). This parameter is required.
        Returns:
        this

      • prettier

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder prettier​(Boolean prettier)
        (experimental) Setup prettier.

        Default: false

        Parameters:
        prettier - Setup prettier. This parameter is required.
        Returns:
        this

      • prettierOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder prettierOptions​(PrettierOptions prettierOptions)
        (experimental) Prettier options.

        Default: - default options

        Parameters:
        prettierOptions - Prettier options. This parameter is required.
        Returns:
        this

      • projenDevDependency

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenDevDependency​(Boolean projenDevDependency)
        (experimental) Indicates of "projen" should be installed as a devDependency.

        Default: true

        Parameters:
        projenDevDependency - Indicates of "projen" should be installed as a devDependency. This parameter is required.
        Returns:
        this

      • projenrcJs

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenrcJs​(Boolean projenrcJs)
        (experimental) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

        Default: - true if projenrcJson is false

        Parameters:
        projenrcJs - Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation. This parameter is required.
        Returns:
        this

      • projenrcJsOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenrcJsOptions​(ProjenrcOptions projenrcJsOptions)
        (experimental) Options for .projenrc.js.

        Default: - default options

        Parameters:
        projenrcJsOptions - Options for .projenrc.js. This parameter is required.
        Returns:
        this

      • projenVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenVersion​(String projenVersion)
        (experimental) Version of projen to install.

        Default: - Defaults to the latest version.

        Parameters:
        projenVersion - Version of projen to install. This parameter is required.
        Returns:
        this

      • pullRequestTemplate

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder pullRequestTemplate​(Boolean pullRequestTemplate)
        (experimental) Include a GitHub pull request template.

        Default: true

        Parameters:
        pullRequestTemplate - Include a GitHub pull request template. This parameter is required.
        Returns:
        this

      • pullRequestTemplateContents

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder pullRequestTemplateContents​(List<String> pullRequestTemplateContents)
        (experimental) The contents of the pull request template.

        Default: - default content

        Parameters:
        pullRequestTemplateContents - The contents of the pull request template. This parameter is required.
        Returns:
        this

      • release

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder release​(Boolean release)
        (experimental) Add release management to this project.

        Default: - true (false for subprojects)

        Parameters:
        release - Add release management to this project. This parameter is required.
        Returns:
        this

      • releaseToNpm

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder releaseToNpm​(Boolean releaseToNpm)
        (experimental) Automatically release to npm when new versions are introduced.

        Default: false

        Parameters:
        releaseToNpm - Automatically release to npm when new versions are introduced. This parameter is required.
        Returns:
        this

      • releaseWorkflow

        @Stability(Deprecated)
@Deprecated
public ConstructLibraryCdk8s.Builder releaseWorkflow​(Boolean releaseWorkflow)
        Deprecated.
        see release.
        (deprecated) DEPRECATED: renamed to release.

        Default: - true if not a subproject

        Parameters:
        releaseWorkflow - DEPRECATED: renamed to release. This parameter is required.
        Returns:
        this

      • workflowBootstrapSteps

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowBootstrapSteps​(List<? extends JobStep> workflowBootstrapSteps)
        (experimental) Workflow steps to use in order to bootstrap this repo.

        Default: "yarn install --frozen-lockfile && yarn projen"

        Parameters:
        workflowBootstrapSteps - Workflow steps to use in order to bootstrap this repo. This parameter is required.
        Returns:
        this

      • workflowGitIdentity

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowGitIdentity​(GitIdentity workflowGitIdentity)
        (experimental) The git identity to use in workflows.

        Default: - GitHub Actions

        Parameters:
        workflowGitIdentity - The git identity to use in workflows. This parameter is required.
        Returns:
        this

      • workflowNodeVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowNodeVersion​(String workflowNodeVersion)
        (experimental) The node version to use in GitHub workflows.

        Default: - same as `minNodeVersion`

        Parameters:
        workflowNodeVersion - The node version to use in GitHub workflows. This parameter is required.
        Returns:
        this

      • workflowPackageCache

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder workflowPackageCache​(Boolean workflowPackageCache)
        (experimental) Enable Node.js package cache in GitHub workflows.

        Default: false

        Parameters:
        workflowPackageCache - Enable Node.js package cache in GitHub workflows. This parameter is required.
        Returns:
        this

      • disableTsconfig

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder disableTsconfig​(Boolean disableTsconfig)
        (experimental) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

        Default: false

        Parameters:
        disableTsconfig - Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler). This parameter is required.
        Returns:
        this

      • disableTsconfigDev

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder disableTsconfigDev​(Boolean disableTsconfigDev)
        (experimental) Do not generate a tsconfig.dev.json file.

        Default: false

        Parameters:
        disableTsconfigDev - Do not generate a tsconfig.dev.json file. This parameter is required.
        Returns:
        this

      • docgen

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder docgen​(Boolean docgen)
        (experimental) Docgen by Typedoc.

        Default: false

        Parameters:
        docgen - Docgen by Typedoc. This parameter is required.
        Returns:
        this

      • docsDirectory

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder docsDirectory​(String docsDirectory)
        (experimental) Docs directory.

        Default: "docs"

        Parameters:
        docsDirectory - Docs directory. This parameter is required.
        Returns:
        this

      • entrypointTypes

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder entrypointTypes​(String entrypointTypes)
        (experimental) The .d.ts file that includes the type declarations for this module.

        Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

        Parameters:
        entrypointTypes - The .d.ts file that includes the type declarations for this module. This parameter is required.
        Returns:
        this

      • eslint

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder eslint​(Boolean eslint)
        (experimental) Setup eslint.

        Default: true

        Parameters:
        eslint - Setup eslint. This parameter is required.
        Returns:
        this

      • eslintOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder eslintOptions​(EslintOptions eslintOptions)
        (experimental) Eslint options.

        Default: - opinionated default options

        Parameters:
        eslintOptions - Eslint options. This parameter is required.
        Returns:
        this

      • libdir

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder libdir​(String libdir)
        (experimental) Typescript artifacts output directory.

        Default: "lib"

        Parameters:
        libdir - Typescript artifacts output directory. This parameter is required.
        Returns:
        this

      • projenrcTs

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenrcTs​(Boolean projenrcTs)
        (experimental) Use TypeScript for your projenrc file (.projenrc.ts).

        Default: false

        Parameters:
        projenrcTs - Use TypeScript for your projenrc file (.projenrc.ts). This parameter is required.
        Returns:
        this

      • projenrcTsOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder projenrcTsOptions​(ProjenrcOptions projenrcTsOptions)
        (experimental) Options for .projenrc.ts.

        Parameters:
        projenrcTsOptions - Options for .projenrc.ts. This parameter is required.
        Returns:
        this

      • sampleCode

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder sampleCode​(Boolean sampleCode)
        (experimental) Generate one-time sample in src/ and test/ if there are no files there.

        Default: true

        Parameters:
        sampleCode - Generate one-time sample in src/ and test/ if there are no files there. This parameter is required.
        Returns:
        this

      • srcdir

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder srcdir​(String srcdir)
        (experimental) Typescript sources directory.

        Default: "src"

        Parameters:
        srcdir - Typescript sources directory. This parameter is required.
        Returns:
        this

      • testdir

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder testdir​(String testdir)
        (experimental) Jest tests directory. Tests files should be named xxx.test.ts.

        If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

        Default: "test"

        Parameters:
        testdir - Jest tests directory. Tests files should be named xxx.test.ts. This parameter is required.
        Returns:
        this

      • tsconfig

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder tsconfig​(TypescriptConfigOptions tsconfig)
        (experimental) Custom TSConfig.

        Default: - default options

        Parameters:
        tsconfig - Custom TSConfig. This parameter is required.
        Returns:
        this

      • tsconfigDev

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder tsconfigDev​(TypescriptConfigOptions tsconfigDev)
        (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).

        Default: - use the production tsconfig options

        Parameters:
        tsconfigDev - Custom tsconfig options for the development tsconfig.json file (used for testing). This parameter is required.
        Returns:
        this

      • tsconfigDevFile

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder tsconfigDevFile​(String tsconfigDevFile)
        (experimental) The name of the development tsconfig.json file.

        Default: "tsconfig.dev.json"

        Parameters:
        tsconfigDevFile - The name of the development tsconfig.json file. This parameter is required.
        Returns:
        this

      • tsJestOptions

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder tsJestOptions​(TsJestOptions tsJestOptions)
        (experimental) Options for ts-jest.

        Parameters:
        tsJestOptions - Options for ts-jest. This parameter is required.
        Returns:
        this

      • typescriptVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder typescriptVersion​(String typescriptVersion)
        (experimental) TypeScript version to use.

        NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

        Default: "latest"

        Parameters:
        typescriptVersion - TypeScript version to use. This parameter is required.
        Returns:
        this

      • author

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder author​(String author)
        (experimental) The name of the library author.

        Default: $GIT_USER_NAME

        Parameters:
        author - The name of the library author. This parameter is required.
        Returns:
        this

      • authorAddress

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder authorAddress​(String authorAddress)
        (experimental) Email or URL of the library author.

        Default: $GIT_USER_EMAIL

        Parameters:
        authorAddress - Email or URL of the library author. This parameter is required.
        Returns:
        this

      • repositoryUrl

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder repositoryUrl​(String repositoryUrl)
        (experimental) Git repository URL.

        Default: $GIT_REMOTE

        Parameters:
        repositoryUrl - Git repository URL. This parameter is required.
        Returns:
        this

      • compat

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder compat​(Boolean compat)
        (experimental) Automatically run API compatibility test against the latest version published to npm after compilation.

        • You can manually run compatibility tests using yarn compat if this feature is disabled.
        • You can ignore compatibility failures by adding lines to a ".compatignore" file.

        Default: false

        Parameters:
        compat - Automatically run API compatibility test against the latest version published to npm after compilation. This parameter is required.
        Returns:
        this

      • compatIgnore

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder compatIgnore​(String compatIgnore)
        (experimental) Name of the ignore file for API compatibility tests.

        Default: ".compatignore"

        Parameters:
        compatIgnore - Name of the ignore file for API compatibility tests. This parameter is required.
        Returns:
        this

      • compressAssembly

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder compressAssembly​(Boolean compressAssembly)
        (experimental) Emit a compressed version of the assembly.

        Default: false

        Parameters:
        compressAssembly - Emit a compressed version of the assembly. This parameter is required.
        Returns:
        this

      • docgenFilePath

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder docgenFilePath​(String docgenFilePath)
        (experimental) File path for generated docs.

        Default: "API.md"

        Parameters:
        docgenFilePath - File path for generated docs. This parameter is required.
        Returns:
        this

      • excludeTypescript

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder excludeTypescript​(List<String> excludeTypescript)
        (experimental) Accepts a list of glob patterns.

        Files matching any of those patterns will be excluded from the TypeScript compiler input.

        By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.

        Parameters:
        excludeTypescript - Accepts a list of glob patterns. This parameter is required.
        Returns:
        this

      • jsiiVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder jsiiVersion​(String jsiiVersion)
        (experimental) Version of the jsii compiler to use.

        Set to "*" if you want to manually manage the version of jsii in your project by managing updates to package.json on your own.

        NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~5.0.0).

        Default: "1.x"

        Parameters:
        jsiiVersion - Version of the jsii compiler to use. This parameter is required.
        Returns:
        this

      • publishToGo

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder publishToGo​(JsiiGoTarget publishToGo)
        (experimental) Publish Go bindings to a git repository.

        Default: - no publishing

        Parameters:
        publishToGo - Publish Go bindings to a git repository. This parameter is required.
        Returns:
        this

      • publishToMaven

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder publishToMaven​(JsiiJavaTarget publishToMaven)
        (experimental) Publish to maven.

        Default: - no publishing

        Parameters:
        publishToMaven - Publish to maven. This parameter is required.
        Returns:
        this

      • publishToNuget

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder publishToNuget​(JsiiDotNetTarget publishToNuget)
        (experimental) Publish to NuGet.

        Default: - no publishing

        Parameters:
        publishToNuget - Publish to NuGet. This parameter is required.
        Returns:
        this

      • publishToPypi

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder publishToPypi​(JsiiPythonTarget publishToPypi)
        (experimental) Publish to pypi.

        Default: - no publishing

        Parameters:
        publishToPypi - Publish to pypi. This parameter is required.
        Returns:
        this

      • rootdir

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder rootdir​(String rootdir)
        Default: "."

        Parameters:
        rootdir - This parameter is required.
        Returns:
        this

      • catalog

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder catalog​(Catalog catalog)
        (experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.

        https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION

        The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through { announce: false }.

        You can also add a Twitter handle through { twitter: 'xx' } which will be mentioned in the tweet.

        Default: - new version will be announced

        Parameters:
        catalog - Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. This parameter is required.
        Returns:
        this
        See Also:
        https://github.com/construct-catalog/catalog

      • cdk8SVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder cdk8SVersion​(String cdk8SVersion)
        (experimental) Minimum target version this library is tested against.

        Default: "1.4.10"

        Parameters:
        cdk8SVersion - Minimum target version this library is tested against. This parameter is required.
        Returns:
        this

      • cdk8SPlusVersionPinning

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder cdk8SPlusVersionPinning​(Boolean cdk8SPlusVersionPinning)
        (experimental) Use pinned version instead of caret version for cdk8s-plus-17.

        You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

        Parameters:
        cdk8SPlusVersionPinning - Use pinned version instead of caret version for cdk8s-plus-17. This parameter is required.
        Returns:
        this

      • cdk8SVersionPinning

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder cdk8SVersionPinning​(Boolean cdk8SVersionPinning)
        (experimental) Use pinned version instead of caret version for CDK8s.

        You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

        Parameters:
        cdk8SVersionPinning - Use pinned version instead of caret version for CDK8s. This parameter is required.
        Returns:
        this

      • constructsVersion

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder constructsVersion​(String constructsVersion)
        (experimental) constructs verion.

        Default: "3.3.196"

        Parameters:
        constructsVersion - constructs verion. This parameter is required.
        Returns:
        this

      • constructsVersionPinning

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder constructsVersionPinning​(Boolean constructsVersionPinning)
        (experimental) Use pinned version instead of caret version for constructs.

        You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

        Parameters:
        constructsVersionPinning - Use pinned version instead of caret version for constructs. This parameter is required.
        Returns:
        this

      • integrationTestAutoDiscover

        @Stability(Experimental)
public ConstructLibraryCdk8s.Builder integrationTestAutoDiscover​(Boolean integrationTestAutoDiscover)
        (experimental) Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project.

        Default: true

        Parameters:
        integrationTestAutoDiscover - Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project. This parameter is required.
        Returns:
        this