Skip to content

docs: clarify label support across git-open-pr providers #6026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xingzihai wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −1
Open

docs: clarify label support across git-open-pr providers #6026

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/git-open-pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ specified source and target branches. This step is often used after a
At present, this feature only supports GitHub, Gitea, Azure DevOps, and
GitLab pull/merge requests.

:::note

Not all providers support all features. Specifically:

- **Labels**: GitHub, GitLab, and Azure DevOps support labeling pull/merge
requests. Gitea does not currently support labels (see
[#6021](https://github.com/akuity/kargo/issues/6021) for status). Bitbucket
does not support labeling of any kind through its APIs.

:::

## Credentials

Git steps are utilizing the [repository credentials](../../50-security/30-managing-secrets.md#repository-credentials)
Expand All @@ -30,7 +41,7 @@ system to access the git repos.
| `createTargetBranch` | `boolean` | N | **Deprecated**. Is a no-op if set. Will be removed in a future release.|
| `title` | `string` | N | The title for the pull request. Kargo generates a title based on the commit messages if it is not explicitly specified. |
| `description` | `string` | N | The description for the pull request. |
| `labels` | `[]string` | N | Labels to add to the pull request. |
| `labels` | `[]string` | N | Labels to add to the pull request. **Note:** Not all providers support labels. GitHub, GitLab, and Azure DevOps support this feature, but Gitea and Bitbucket do not. |

## Output

Expand Down
Loading