Skip to content

Commit 5f9ac2a

Browse files
committed
chore(directives): deprecate messageFromSteps
Signed-off-by: Hidde Beydals <[email protected]>
1 parent 9f34025 commit 5f9ac2a

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/git-commit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ desired state and is commonly followed by a [`git-push` step](git-push.md).
1515
|------|------|----------|-------------|
1616
| `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. |
1717
| `message` | `string` | N | The commit message. Mutually exclusive with `messageFromSteps`. |
18-
| `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`. |
18+
| `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.__ |
1919
| `author` | `[]object` | N | Optionally provider authorship information for the commit. |
2020
| `author.name` | `string` | N | The committer's name. |
2121
| `author.email` | `string` | N | The committer's email address. |

internal/directives/schemas/git-commit-config.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@
3535
},
3636
"messageFromSteps": {
3737
"type": "array",
38-
"description": "TODO",
38+
"deprecated": true,
39+
"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.",
3940
"minItems": 1,
4041
"items": {
4142
"type": "string",

internal/directives/zz_config_types.go

+5-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

ui/src/gen/directives/git-commit-config.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
},
2727
"messageFromSteps": {
2828
"type": "array",
29-
"description": "TODO",
29+
"deprecated": true,
30+
"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.",
3031
"items": {
3132
"type": "string",
3233
"minLength": 1

0 commit comments

Comments
 (0)