Skip to content

Commit

Permalink
feat: Support sourcing resources from git (#595)
Browse files Browse the repository at this point in the history
- Added support for git references in deployment/runbook processes to allow for sourcing scripts or other resources from git repositories if the action type supports it
  • Loading branch information
tleed5 authored Mar 19, 2024
1 parent 0503d4c commit f158fa4
Show file tree
Hide file tree
Showing 13 changed files with 670 additions and 1 deletion.
128 changes: 128 additions & 0 deletions docs/resources/deployment_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -229,6 +230,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--action--git_dependency"></a>
### Nested Schema for `step.action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--action--package"></a>
### Nested Schema for `step.action.package`

Expand Down Expand Up @@ -283,6 +299,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--apply_terraform_template_action--git_dependency))
- `google_cloud_account` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--step--apply_terraform_template_action--google_cloud_account))
- `id` (String) The unique ID for this resource.
- `inline_template` (String)
Expand Down Expand Up @@ -362,6 +379,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--apply_terraform_template_action--git_dependency"></a>
### Nested Schema for `step.apply_terraform_template_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--apply_terraform_template_action--google_cloud_account"></a>
### Nested Schema for `step.apply_terraform_template_action.google_cloud_account`

Expand Down Expand Up @@ -439,6 +471,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--deploy_kubernetes_secret_action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -473,6 +506,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--deploy_kubernetes_secret_action--git_dependency"></a>
### Nested Schema for `step.deploy_kubernetes_secret_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--deploy_kubernetes_secret_action--package"></a>
### Nested Schema for `step.deploy_kubernetes_secret_action.package`

Expand Down Expand Up @@ -508,6 +556,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--deploy_package_action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -556,6 +605,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--deploy_package_action--git_dependency"></a>
### Nested Schema for `step.deploy_package_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--deploy_package_action--package"></a>
### Nested Schema for `step.deploy_package_action.package`

Expand Down Expand Up @@ -621,6 +685,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--deploy_windows_service_action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -670,6 +735,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--deploy_windows_service_action--git_dependency"></a>
### Nested Schema for `step.deploy_windows_service_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--deploy_windows_service_action--package"></a>
### Nested Schema for `step.deploy_windows_service_action.package`

Expand Down Expand Up @@ -705,6 +785,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--manual_intervention_action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -737,6 +818,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--manual_intervention_action--git_dependency"></a>
### Nested Schema for `step.manual_intervention_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--manual_intervention_action--package"></a>
### Nested Schema for `step.manual_intervention_action.package`

Expand Down Expand Up @@ -771,6 +867,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--run_kubectl_script_action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -812,6 +909,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--run_kubectl_script_action--git_dependency"></a>
### Nested Schema for `step.run_kubectl_script_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--run_kubectl_script_action--package"></a>
### Nested Schema for `step.run_kubectl_script_action.package`

Expand Down Expand Up @@ -863,6 +975,7 @@ Optional:
- `environments` (List of String) The environments within which this deployment action will run.
- `excluded_environments` (List of String) The environments that this step will be skipped in
- `features` (List of String) A list of enabled features for this action.
- `git_dependency` (Block Set, Max: 1) Configuration for resource sourcing from a git repository. (see [below for nested schema](#nestedblock--step--run_script_action--git_dependency))
- `id` (String) The unique ID for this resource.
- `is_disabled` (Boolean) Indicates the disabled status of this deployment action.
- `is_required` (Boolean) Indicates the required status of this deployment action.
Expand Down Expand Up @@ -904,6 +1017,21 @@ Optional:
- `image` (String)


<a id="nestedblock--step--run_script_action--git_dependency"></a>
### Nested Schema for `step.run_script_action.git_dependency`

Required:

- `default_branch` (String) Name of the default branch of the repository.
- `git_credential_type` (String) The Git credential authentication type.
- `repository_uri` (String) The Git URI for the repository where this resource is sourced from.

Optional:

- `file_path_filters` (List of String) List of file path filters used to narrow down the directory where files are to be sourced from. Supports glob patten syntax.
- `git_credential_id` (String) ID of an existing Git credential.


<a id="nestedblock--step--run_script_action--package"></a>
### Nested Schema for `step.run_script_action.package`

Expand Down
Loading

0 comments on commit f158fa4

Please sign in to comment.