Package io.github.cdklabs.projen.github

Interface DependabotRegistry

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DependabotRegistry.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.068Z")
@Stability(Experimental)
public interface DependabotRegistry
extends software.amazon.jsii.JsiiSerializable

(experimental) Use to add private registry support for dependabot.

See Also:

https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#configuration-options-for-private-registries

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DependabotRegistry.Builder	A builder for DependabotRegistry
static class	DependabotRegistry.Jsii$Proxy	An implementation for DependabotRegistry

Method Summary

Modifier and Type	Method	Description
static DependabotRegistry.Builder	builder()
default String	getKey()	(experimental) A reference to a Dependabot secret containing an access key for this registry.
default String	getOrganization()	(experimental) Used with the hex-organization registry type.
default String	getPassword()	(experimental) A reference to a Dependabot secret containing the password for the specified user.
default Boolean	getReplacesBase()	(experimental) For registries with type: python-index, if the boolean value is true, pip esolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).
default String	getToken()	(experimental) Secret token for dependabot access e.g.
DependabotRegistryType	getType()	(experimental) Registry type e.g.
String	getUrl()	(experimental) Url for the registry e.g.
default String	getUsername()	(experimental) The username that Dependabot uses to access the registry.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getType

@Stability(Experimental)
@NotNull
DependabotRegistryType getType()

(experimental) Registry type e.g. 'npm-registry' or 'docker-registry'.

getUrl

@Stability(Experimental)
@NotNull
String getUrl()

(experimental) Url for the registry e.g. 'https://npm.pkg.github.com' or 'registry.hub.docker.com'.

getKey

@Stability(Experimental)
@Nullable
default String getKey()

(experimental) A reference to a Dependabot secret containing an access key for this registry.

Default: undefined

getOrganization

@Stability(Experimental)
@Nullable
default String getOrganization()

(experimental) Used with the hex-organization registry type.

Default: undefined

See Also:

https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#hex-organization

getPassword

@Stability(Experimental)
@Nullable
default String getPassword()

(experimental) A reference to a Dependabot secret containing the password for the specified user.

Default: undefined

getReplacesBase

@Stability(Experimental)
@Nullable
default Boolean getReplacesBase()

(experimental) For registries with type: python-index, if the boolean value is true, pip esolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).

Default: undefined

getToken

@Stability(Experimental)
@Nullable
default String getToken()

(experimental) Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'.

Default: undefined

getUsername

@Stability(Experimental)
@Nullable
default String getUsername()

(experimental) The username that Dependabot uses to access the registry.

Default: - do not authenticate

builder

@Stability(Experimental)
static DependabotRegistry.Builder builder()

Returns:

a DependabotRegistry.Builder of DependabotRegistry