Package io.github.cdklabs.projen.github

Interface DependabotOptions

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    DependabotOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.067Z")
@Stability(Experimental)
public interface DependabotOptions
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getAllow

        @Stability(Experimental)
@Nullable
default List<DependabotAllow> getAllow()
        (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: []

      • getAssignees

        @Stability(Experimental)
@Nullable
default List<String> getAssignees()
        (experimental) Specify individual assignees or teams of assignees for all pull requests raised for a package manager.

        Default: []

      • getGroups

        @Stability(Experimental)
@Nullable
default Map<String,​DependabotGroup> getGroups()
        (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: []

      • getIgnore

        @Stability(Experimental)
@Nullable
default List<DependabotIgnore> getIgnore()
        (experimental) You can use the ignore option to customize which dependencies are updated.

        The ignore option supports the following options.

        Default: []

      • getIgnoreProjen

        @Stability(Experimental)
@Nullable
default Boolean getIgnoreProjen()
        (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

      • getLabels

        @Stability(Experimental)
@Nullable
default List<String> getLabels()
        (experimental) List of labels to apply to the created PR's.

      • getOpenPullRequestsLimit

        @Stability(Experimental)
@Nullable
default Number getOpenPullRequestsLimit()
        (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

      • getRegistries

        @Stability(Experimental)
@Nullable
default Map<String,​DependabotRegistry> getRegistries()
        (experimental) Map of package registries to use.

        Default: - use public registries

      • getReviewers

        @Stability(Experimental)
@Nullable
default List<String> getReviewers()
        (experimental) Specify individual reviewers or teams of reviewers for all pull requests raised for a package manager.

        Default: []

      • getScheduleInterval

        @Stability(Experimental)
@Nullable
default DependabotScheduleInterval getScheduleInterval()
        (experimental) How often to check for new versions and raise pull requests.

        Default: ScheduleInterval.DAILY

      • getVersioningStrategy

        @Stability(Experimental)
@Nullable
default VersioningStrategy getVersioningStrategy()
        (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.