Skip to content

Commit cce6b9a

Browse files
krancourkrancour
committed
merge main
Signed-off-by: Kent Rancourt <[email protected]>
2 parents b2b5792 + 372bd42 commit cce6b9a

File tree

38 files changed

+310
-304
lines changed

38 files changed

+310
-304
lines changed

‎docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/gha-dispatch-workflow.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ sidebar_label: gha-dispatch-workflow
33
description: Dispatches GitHub Actions workflows using the workflow_dispatch event.
44
---
55

6+
# `gha-dispatch-workflow`
7+
68
<span class="tag professional"></span>
79
<span class="tag beta"></span>
8-
# `gha-dispatch-workflow`
910

1011
:::info
1112
This promotion step is only available in Kargo on the [Akuity Platform](https://akuity.io/akuity-platform), versions v1.8 and above.
@@ -17,9 +18,9 @@ The `gha-dispatch-workflow` promotion step provides integration with GitHub Acti
1718

1819
All GitHub Actions operations require proper authentication credentials stored in a Kubernetes `Secret`.
1920

20-
| Name | Type | Required | Description |
21-
|----------------------------|----------|----------|--------------------------------------------------------------------------------------|
22-
| `credentials.secretName` | `string` | Y | Name of the `Secret` containing the GitHub credentials in the project namespace. |
21+
| Name | Type | Required | Description |
22+
| ------------------------ | -------- | -------- | -------------------------------------------------------------------------------- |
23+
| `credentials.secretName` | `string` | Y | Name of the `Secret` containing the GitHub credentials in the project namespace. |
2324

2425
The referenced `Secret` should contain the following keys:
2526

@@ -40,19 +41,19 @@ The GitHub token must have the following permissions:
4041

4142
## Configuration
4243

43-
| Name | Type | Required | Description |
44-
|-----------------|-----------|----------|-------------------------------------------------------------------------------------------------------------|
45-
| `owner` | `string` | Y | The owner of the repository (user or organization). |
46-
| `repo` | `string` | Y | The name of the repository. |
47-
| `workflowFile` | `string` | Y | The workflow filename in .github/workflows (e.g., 'deploy.yml'). |
48-
| `ref` | `string` | Y | The git reference (branch or tag) to run the workflow on. |
49-
| `inputs` | `object` | N | Input parameters to pass to the workflow as defined in the workflow's `workflow_dispatch` inputs. |
50-
| `timeout` | `integer` | N | Timeout in seconds to wait for the workflow run to be created after dispatch (default: 60, max: 300). |
44+
| Name | Type | Required | Description |
45+
| -------------- | --------- | -------- | ----------------------------------------------------------------------------------------------------- |
46+
| `owner` | `string` | Y | The owner of the repository (user or organization). |
47+
| `repo` | `string` | Y | The name of the repository. |
48+
| `workflowFile` | `string` | Y | The workflow filename in .github/workflows (e.g., 'deploy.yml'). |
49+
| `ref` | `string` | Y | The git reference (branch or tag) to run the workflow on. |
50+
| `inputs` | `object` | N | Input parameters to pass to the workflow as defined in the workflow's `workflow_dispatch` inputs. |
51+
| `timeout` | `integer` | N | Timeout in seconds to wait for the workflow run to be created after dispatch (default: 60, max: 300). |
5152

5253
## Output
5354

54-
| Name | Type | Description |
55-
|---------|-----------|---------------------------------------------------------------------------|
55+
| Name | Type | Description |
56+
| ------- | --------- | --------------------------------------------------------------------------- |
5657
| `runID` | `integer` | The ID of the dispatched workflow run that can be used for status tracking. |
5758

5859
## Example

‎docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/gha-wait-for-workflow.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ sidebar_label: gha-wait-for-workflow
33
description: Waits for GitHub Actions workflow runs to complete with optional status validation.
44
---
55

6+
# `gha-wait-for-workflow`
7+
68
<span class="tag professional"></span>
79
<span class="tag beta"></span>
8-
# `gha-wait-for-workflow`
910

1011
:::info
1112
This promotion step is only available in Kargo on the [Akuity Platform](https://akuity.io/akuity-platform), versions v1.8 and above.
@@ -17,9 +18,9 @@ The `gha-wait-for-workflow` promotion step provides integration with GitHub Acti
1718

1819
All GitHub Actions operations require proper authentication credentials stored in a Kubernetes `Secret`.
1920

20-
| Name | Type | Required | Description |
21-
|----------------------------|----------|----------|--------------------------------------------------------------------------------------|
22-
| `credentials.secretName` | `string` | Y | Name of the `Secret` containing the GitHub credentials in the project namespace. |
21+
| Name | Type | Required | Description |
22+
| ------------------------ | -------- | -------- | -------------------------------------------------------------------------------- |
23+
| `credentials.secretName` | `string` | Y | Name of the `Secret` containing the GitHub credentials in the project namespace. |
2324

2425
The referenced `Secret` should contain the following keys:
2526

@@ -39,11 +40,11 @@ The GitHub token must have the following permissions:
3940

4041
## Configuration
4142

42-
| Name | Type | Required | Description |
43-
|----------------------|-----------|----------|-------------------------------------------------------------------------------------|
44-
| `owner` | `string` | Y | The owner of the repository (user or organization). |
45-
| `repo` | `string` | Y | The name of the repository. |
46-
| `runID` | `integer` | Y | The workflow run ID to wait for. |
43+
| Name | Type | Required | Description |
44+
| -------------------- | --------- | -------- | ------------------------------------------------------------------------------------------ |
45+
| `owner` | `string` | Y | The owner of the repository (user or organization). |
46+
| `repo` | `string` | Y | The name of the repository. |
47+
| `runID` | `integer` | Y | The workflow run ID to wait for. |
4748
| `expectedConclusion` | `string` | N | The expected final conclusion status. If not provided, conclusion status is not validated. |
4849

4950
Valid values for `expectedConclusion`:
@@ -58,8 +59,8 @@ Valid values for `expectedConclusion`:
5859

5960
## Output
6061

61-
| Name | Type | Description |
62-
|--------------|----------|----------------------------------------------------------------|
62+
| Name | Type | Description |
63+
| ------------ | -------- | ----------------------------------------------------------------- |
6364
| `conclusion` | `string` | The final conclusion status of the workflow run after completion. |
6465

6566
## Example

‎docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/git-merge-pr.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,31 @@ sidebar_label: git-merge-pr
33
description: Merges an open pull request.
44
---
55

6-
<span class="tag beta"></span>
76
# `git-merge-pr`
87

8+
<span class="tag beta"></span>
9+
910
`git-merge-pr` merges an open pull request. This step commonly follows a
1011
[`git-open-pr`](git-open-pr.md) step.
1112

1213
## Configuration
1314

14-
| Name | Type | Required | Description |
15-
|------|------|----------|-------------|
16-
| `repoURL` | `string` | Y | The URL of a remote Git repository. |
17-
| `provider` | `string` | N | The name of the Git provider to use. Currently `azure`, `bitbucket`, `gitea`, `github`, and `gitlab` are supported. Kargo will try to infer the provider if it is not explicitly specified. |
18-
| `insecureSkipTLSVerify` | `boolean` | N | Indicates whether to bypass TLS certificate verification when interfacing with the Git provider. Setting this to `true` is highly discouraged in production. |
19-
| `prNumber` | `integer` | Y | The pull request number to merge. |
20-
| `wait` | `boolean` | N | If `true`, the step will return a running status instead of failing when the PR is not yet mergeable. The merge will be retried on the next reconciliation until it succeeds or times out. Default is `false`. |
15+
| Name | Type | Required | Description |
16+
| ----------------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17+
| `repoURL` | `string` | Y | The URL of a remote Git repository. |
18+
| `provider` | `string` | N | The name of the Git provider to use. Currently `azure`, `bitbucket`, `gitea`, `github`, and `gitlab` are supported. Kargo will try to infer the provider if it is not explicitly specified. |
19+
| `insecureSkipTLSVerify` | `boolean` | N | Indicates whether to bypass TLS certificate verification when interfacing with the Git provider. Setting this to `true` is highly discouraged in production. |
20+
| `prNumber` | `integer` | Y | The pull request number to merge. |
21+
| `wait` | `boolean` | N | If `true`, the step will return a running status instead of failing when the PR is not yet mergeable. The merge will be retried on the next reconciliation until it succeeds or times out. Default is `false`. |
2122

2223
:::warning
2324
The `wait` option is unreliable for repositories hosted by Bitbucket due to API limitations.
2425
:::
2526

2627
## Output
2728

28-
| Name | Type | Description |
29-
|------|------|-------------|
29+
| Name | Type | Description |
30+
| -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3031
| `commit` | `string` | The ID (SHA) of the merge commit created after successfully merging the pull request. Typically, a subsequent [`argocd-update`](argocd-update.md) step will reference this output to learn the ID of the commit that an applicable Argo CD `ApplicationSource` should be observably synced to under healthy conditions. |
3132

3233
## Examples

0 commit comments

Comments
 (0)