Package io.github.cdklabs.projen.github

Class Dependabot.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Dependabot>
    Enclosing class:
    Dependabot
    @Stability(Experimental)
public static final class Dependabot.Builder
extends Object
implements software.amazon.jsii.Builder<Dependabot>
    (experimental) A fluent builder for Dependabot.

    • Method Detail

      • allow

        @Stability(Experimental)
public Dependabot.Builder allow​(List<? extends DependabotAllow> allow)
        (experimental) https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow.

        Use the allow option to customize which dependencies are updated. This applies to both version and security updates.

        Default: []

        Parameters:
        allow - https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#allow. This parameter is required.
        Returns:
        this

      • assignees

        @Stability(Experimental)
public Dependabot.Builder assignees​(List<String> assignees)
        (experimental) Specify individual assignees or teams of assignees for all pull requests raised for a package manager.

        Default: []

        Parameters:
        assignees - Specify individual assignees or teams of assignees for all pull requests raised for a package manager. This parameter is required.
        Returns:
        this

      • groups

        @Stability(Experimental)
public Dependabot.Builder groups​(Map<String,​? extends DependabotGroup> groups)
        (experimental) https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups.

        You can create groups to package dependency updates together into a single PR.

        Default: []

        Parameters:
        groups - https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups. This parameter is required.
        Returns:
        this

      • ignore

        @Stability(Experimental)
public Dependabot.Builder ignore​(List<? extends DependabotIgnore> ignore)
        (experimental) You can use the ignore option to customize which dependencies are updated.

        The ignore option supports the following options.

        Default: []

        Parameters:
        ignore - You can use the ignore option to customize which dependencies are updated. This parameter is required.
        Returns:
        this

      • ignoreProjen

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

        Parameters:
        ignoreProjen - Ignores updates to projen. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Experimental)
public Dependabot.Builder labels​(List<String> labels)
        (experimental) List of labels to apply to the created PR's.

        Parameters:
        labels - List of labels to apply to the created PR's. This parameter is required.
        Returns:
        this

      • openPullRequestsLimit

        @Stability(Experimental)
public Dependabot.Builder openPullRequestsLimit​(Number openPullRequestsLimit)
        (experimental) Sets the maximum of pull requests Dependabot opens for version updates.

        Dependabot will not open any new requests until some of those open requests are merged or closed.

        Default: 5

        Parameters:
        openPullRequestsLimit - Sets the maximum of pull requests Dependabot opens for version updates. This parameter is required.
        Returns:
        this

      • registries

        @Stability(Experimental)
public Dependabot.Builder registries​(Map<String,​? extends DependabotRegistry> registries)
        (experimental) Map of package registries to use.

        Default: - use public registries

        Parameters:
        registries - Map of package registries to use. This parameter is required.
        Returns:
        this

      • reviewers

        @Stability(Experimental)
public Dependabot.Builder reviewers​(List<String> reviewers)
        (experimental) Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager.

        Default: []

        Parameters:
        reviewers - Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager. This parameter is required.
        Returns:
        this

      • scheduleInterval

        @Stability(Experimental)
public Dependabot.Builder scheduleInterval​(DependabotScheduleInterval scheduleInterval)
        (experimental) How often to check for new versions and raise pull requests.

        Default: ScheduleInterval.DAILY

        Parameters:
        scheduleInterval - How often to check for new versions and raise pull requests. This parameter is required.
        Returns:
        this

      • versioningStrategy

        @Stability(Experimental)
public Dependabot.Builder versioningStrategy​(VersioningStrategy versioningStrategy)
        (experimental) The strategy to use when edits manifest and lock files.

        Default: VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build.

        Parameters:
        versioningStrategy - The strategy to use when edits manifest and lock files. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public Dependabot build()
        Specified by:
        build in interface software.amazon.jsii.Builder<Dependabot>
        Returns:
        a newly built instance of Dependabot.