Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ExternalScmConfiguration

An external SCM configuration extends a SCM Configuration with necessary data to reach and use the Source Code Management tool/platform used by a Remediation Recipe. An external SCM in ADM refers to GitHub, or GitLab.

Properties

branch

branch: string

The branch used by ADM to patch vulnerabilities.

Optional buildFileLocation

buildFileLocation: undefined | string

The location of the build file relative to the root of the repository. Only Maven build files (POM) are currently supported. If this property is not specified, ADM will use the build file located at the root of the repository.

externalScmType

externalScmType: ExternalScmType

The type of External Source Code Management.

isAutomergeEnabled

isAutomergeEnabled: boolean

If true, the Pull Request (PR) will be merged after the verify stage completes successfully If false, the PR with the proposed changes must be reviewed and manually merged.

patSecretId

patSecretId: string

The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The secret provides the credentials necessary to authenticate against the SCM.

repositoryUrl

repositoryUrl: string

The repository URL for the SCM. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName] For GitLab the expected format is https://gitlab.com/[groupName]/[repoName]

Const scmType

scmType: string = "EXTERNAL_SCM"

Optional username

username: undefined | string

The username for the SCM (to perform operations such as cloning or pushing via HTTP).

Methods

getDeserializedJsonObj

getJsonObj