GitHubActionsConfiguration

class oci.adm.models.GitHubActionsConfiguration(**kwargs)

Bases: VerifyConfiguration

Extends a Verify configuration with appropriate data to reach and use the build service provided by a GitHub Action.

Attributes:

BUILD_SERVICE_TYPE_GITHUB_ACTIONS

A constant which can be used with the build_service_type property of a VerifyConfiguration.

BUILD_SERVICE_TYPE_GITLAB_PIPELINE

A constant which can be used with the build_service_type property of a VerifyConfiguration.

BUILD_SERVICE_TYPE_JENKINS_PIPELINE

A constant which can be used with the build_service_type property of a VerifyConfiguration.

BUILD_SERVICE_TYPE_NONE

A constant which can be used with the build_service_type property of a VerifyConfiguration.

BUILD_SERVICE_TYPE_OCI_DEVOPS_BUILD

A constant which can be used with the build_service_type property of a VerifyConfiguration.

additional_parameters

Gets the additional_parameters of this GitHubActionsConfiguration.

build_service_type

[Required] Gets the build_service_type of this VerifyConfiguration.

pat_secret_id

[Required] Gets the pat_secret_id of this GitHubActionsConfiguration.

repository_url

[Required] Gets the repository_url of this GitHubActionsConfiguration.

username

[Required] Gets the username of this GitHubActionsConfiguration.

workflow_name

[Required] Gets the workflow_name of this GitHubActionsConfiguration.

Methods:

__init__(**kwargs)

Initializes a new GitHubActionsConfiguration object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

BUILD_SERVICE_TYPE_GITHUB_ACTIONS = 'GITHUB_ACTIONS'

A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “GITHUB_ACTIONS”

BUILD_SERVICE_TYPE_GITLAB_PIPELINE = 'GITLAB_PIPELINE'

A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “GITLAB_PIPELINE”

BUILD_SERVICE_TYPE_JENKINS_PIPELINE = 'JENKINS_PIPELINE'

A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “JENKINS_PIPELINE”

BUILD_SERVICE_TYPE_NONE = 'NONE'

A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “NONE”

BUILD_SERVICE_TYPE_OCI_DEVOPS_BUILD = 'OCI_DEVOPS_BUILD'

A constant which can be used with the build_service_type property of a VerifyConfiguration. This constant has a value of “OCI_DEVOPS_BUILD”

__init__(**kwargs)

Initializes a new GitHubActionsConfiguration object with values from keyword arguments. The default value of the build_service_type attribute of this class is GITHUB_ACTIONS and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • build_service_type (str) – The value to assign to the build_service_type property of this GitHubActionsConfiguration. Allowed values for this property are: “OCI_DEVOPS_BUILD”, “GITLAB_PIPELINE”, “GITHUB_ACTIONS”, “JENKINS_PIPELINE”, “NONE”

  • repository_url (str) – The value to assign to the repository_url property of this GitHubActionsConfiguration.

  • pat_secret_id (str) – The value to assign to the pat_secret_id property of this GitHubActionsConfiguration.

  • username (str) – The value to assign to the username property of this GitHubActionsConfiguration.

  • workflow_name (str) – The value to assign to the workflow_name property of this GitHubActionsConfiguration.

  • additional_parameters (dict(str, str)) – The value to assign to the additional_parameters property of this GitHubActionsConfiguration.

property additional_parameters

Gets the additional_parameters of this GitHubActionsConfiguration. Additional key-value pairs passed as parameters to the build service when running an experiment.

Returns

The additional_parameters of this GitHubActionsConfiguration.

Return type

dict(str, str)

property build_service_type

[Required] Gets the build_service_type of this VerifyConfiguration. The type of Build Service.

Allowed values for this property are: “OCI_DEVOPS_BUILD”, “GITLAB_PIPELINE”, “GITHUB_ACTIONS”, “JENKINS_PIPELINE”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The build_service_type of this VerifyConfiguration.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property pat_secret_id

[Required] Gets the pat_secret_id of this GitHubActionsConfiguration. The Oracle Cloud Identifier (OCID) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the GitHub Action.

Returns

The pat_secret_id of this GitHubActionsConfiguration.

Return type

str

property repository_url

[Required] Gets the repository_url of this GitHubActionsConfiguration. The location of the repository where the GitHub Actions is defined. 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]

Returns

The repository_url of this GitHubActionsConfiguration.

Return type

str

property username

[Required] Gets the username of this GitHubActionsConfiguration. The username that will trigger the GitHub Action.

Returns

The username of this GitHubActionsConfiguration.

Return type

str

property workflow_name

[Required] Gets the workflow_name of this GitHubActionsConfiguration. The name of the GitHub Actions workflow that defines the build pipeline.

Returns

The workflow_name of this GitHubActionsConfiguration.

Return type

str