Skip to content

chore(directives): deprecate messageFromSteps #3560

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

Merged
merged 1 commit into from
Feb 25, 2025
Merged

chore(directives): deprecate messageFromSteps #3560

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/git-commit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ desired state and is commonly followed by a [`git-push` step](git-push.md).
|------|------|----------|-------------|
| `path` | `string` | Y | Path to a Git working tree containing changes to be committed. This path is relative to the temporary workspace that Kargo provisions for use by the promotion process. |
| `message` | `string` | N | The commit message. Mutually exclusive with `messageFromSteps`. |
| `messageFromSteps` | `[]string` | N | References the `commitMessage` output of previous steps. When one or more are specified, the commit message will be constructed by concatenating the messages from individual steps. Mutually exclusive with `message`. |
| `messageFromSteps` | `[]string` | N | References the `commitMessage` output of previous steps. When one or more are specified, the commit message will be constructed by concatenating the messages from individual steps. Mutually exclusive with `message`.<br/><br/>__Deprecated: Use `message` with an expression instead. Will be removed in v1.5.0.__ |
| `author` | `[]object` | N | Optionally provider authorship information for the commit. |
| `author.name` | `string` | N | The committer's name. |
| `author.email` | `string` | N | The committer's email address. |
Expand Down
3 changes: 2 additions & 1 deletion internal/directives/schemas/git-commit-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
},
"messageFromSteps": {
"type": "array",
"description": "TODO",
"deprecated": true,
"description": "References the `commitMessage` output of previous steps. When one or more are specified, the commit message will be constructed by concatenating the messages from individual steps. Mutually exclusive with `message`.\n\nDeprecated: Use 'message' with an expression instead. Will be removed in v1.5.0.",
"minItems": 1,
"items": {
"type": "string",
Expand Down
6 changes: 5 additions & 1 deletion internal/directives/zz_config_types.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion ui/src/gen/directives/git-commit-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
},
"messageFromSteps": {
"type": "array",
"description": "TODO",
"deprecated": true,
"description": "References the `commitMessage` output of previous steps. When one or more are specified, the commit message will be constructed by concatenating the messages from individual steps. Mutually exclusive with `message`.\n\nDeprecated: Use 'message' with an expression instead. Will be removed in v1.5.0.",
"items": {
"type": "string",
"minLength": 1
Expand Down