From cec177dac781af5a4a4a130cb921c6a98a4ae0a8 Mon Sep 17 00:00:00 2001 From: Josh Berry Date: Wed, 4 Dec 2024 11:46:00 -0500 Subject: [PATCH] Fix whitespace in `temporal batch --help` output Closes #721. --- temporalcli/commands.gen.go | 4 ++-- temporalcli/commandsgen/commands.yml | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/temporalcli/commands.gen.go b/temporalcli/commands.gen.go index 7def8637..c01963a0 100644 --- a/temporalcli/commands.gen.go +++ b/temporalcli/commands.gen.go @@ -423,9 +423,9 @@ func NewTemporalBatchCommand(cctx *CommandContext, parent *TemporalCommand) *Tem s.Command.Use = "batch" s.Command.Short = "Manage running batch jobs" if hasHighlighting { - s.Command.Long = "List or terminate running batch jobs.\n\nA batch job executes a command on multiple Workflow Executions at once. Create\nbatch jobs by passing \x1b[1m--query\x1b[0m to commands that support it. For example, to\ncreate a batch job to cancel a set of Workflow Executions:\n\n\x1b[1mtemporal workflow cancel \\\n --query 'ExecutionStatus = \"Running\" AND WorkflowType=\"YourWorkflow\"' \\\n --reason \"Testing\"\x1b[0m\n\nQuery Quick Reference:\n\n\x1b[1m+----------------------------------------------------------------------------+\n| Composition: |\n| - Data types: String literals with single or double quotes, |\n| Numbers (integer and floating point), Booleans |\n| - Comparison: '=', '!=', '>', '>=', '<', '<=' |\n| - Expressions/Operators: 'IN array', 'BETWEEN value AND value', |\n| 'STARTS_WITH string', 'IS NULL', 'IS NOT NULL', 'expr AND expr', |\n| 'expr OR expr', '( expr )' |\n| - Array: '( comma-separated-values )' |\n| |\n| Please note: |\n| - Wrap attributes with backticks if it contains characters not in |\n| \x1b[1m[a-zA-Z0-9]\x1b[0m. |\n| - \x1b[1mSTARTS_WITH\x1b[0m is only available for Keyword search attributes. |\n+----------------------------------------------------------------------------+\x1b[0m\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation." + s.Command.Long = "List or terminate running batch jobs.\n\nA batch job executes a command on multiple Workflow Executions at once. Create\nbatch jobs by passing \x1b[1m--query\x1b[0m to commands that support it. For example, to\ncreate a batch job to cancel a set of Workflow Executions:\n\n\x1b[1mtemporal workflow cancel \\\n --query 'ExecutionStatus = \"Running\" AND WorkflowType=\"YourWorkflow\"' \\\n --reason \"Testing\"\x1b[0m\n\nQuery Quick Reference:\n\n\x1b[1m+----------------------------------------------------------------------------+\n| Composition: |\n| - Data types: String literals with single or double quotes, |\n| Numbers (integer and floating point), Booleans |\n| - Comparison: '=', '!=', '>', '>=', '<', '<=' |\n| - Expressions/Operators: 'IN array', 'BETWEEN value AND value', |\n| 'STARTS_WITH string', 'IS NULL', 'IS NOT NULL', 'expr AND expr', |\n| 'expr OR expr', '( expr )' |\n| - Array: '( comma-separated-values )' |\n| |\n| Please note: |\n| - Wrap attributes with backticks if it contains characters not in |\n| [a-zA-Z0-9]. |\n| - STARTS_WITH is only available for Keyword search attributes. |\n+----------------------------------------------------------------------------+\x1b[0m\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation." } else { - s.Command.Long = "List or terminate running batch jobs.\n\nA batch job executes a command on multiple Workflow Executions at once. Create\nbatch jobs by passing `--query` to commands that support it. For example, to\ncreate a batch job to cancel a set of Workflow Executions:\n\n```\ntemporal workflow cancel \\\n --query 'ExecutionStatus = \"Running\" AND WorkflowType=\"YourWorkflow\"' \\\n --reason \"Testing\"\n```\n\nQuery Quick Reference:\n\n```\n+----------------------------------------------------------------------------+\n| Composition: |\n| - Data types: String literals with single or double quotes, |\n| Numbers (integer and floating point), Booleans |\n| - Comparison: '=', '!=', '>', '>=', '<', '<=' |\n| - Expressions/Operators: 'IN array', 'BETWEEN value AND value', |\n| 'STARTS_WITH string', 'IS NULL', 'IS NOT NULL', 'expr AND expr', |\n| 'expr OR expr', '( expr )' |\n| - Array: '( comma-separated-values )' |\n| |\n| Please note: |\n| - Wrap attributes with backticks if it contains characters not in |\n| `[a-zA-Z0-9]`. |\n| - `STARTS_WITH` is only available for Keyword search attributes. |\n+----------------------------------------------------------------------------+\n```\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation." + s.Command.Long = "List or terminate running batch jobs.\n\nA batch job executes a command on multiple Workflow Executions at once. Create\nbatch jobs by passing `--query` to commands that support it. For example, to\ncreate a batch job to cancel a set of Workflow Executions:\n\n```\ntemporal workflow cancel \\\n --query 'ExecutionStatus = \"Running\" AND WorkflowType=\"YourWorkflow\"' \\\n --reason \"Testing\"\n```\n\nQuery Quick Reference:\n\n```\n+----------------------------------------------------------------------------+\n| Composition: |\n| - Data types: String literals with single or double quotes, |\n| Numbers (integer and floating point), Booleans |\n| - Comparison: '=', '!=', '>', '>=', '<', '<=' |\n| - Expressions/Operators: 'IN array', 'BETWEEN value AND value', |\n| 'STARTS_WITH string', 'IS NULL', 'IS NOT NULL', 'expr AND expr', |\n| 'expr OR expr', '( expr )' |\n| - Array: '( comma-separated-values )' |\n| |\n| Please note: |\n| - Wrap attributes with backticks if it contains characters not in |\n| [a-zA-Z0-9]. |\n| - STARTS_WITH is only available for Keyword search attributes. |\n+----------------------------------------------------------------------------+\n```\n\nVisit https://docs.temporal.io/visibility to read more about Search Attributes\nand Query creation." } s.Command.Args = cobra.NoArgs s.Command.AddCommand(&NewTemporalBatchDescribeCommand(cctx, &s).Command) diff --git a/temporalcli/commandsgen/commands.yml b/temporalcli/commandsgen/commands.yml index 49d49be2..5340be8b 100644 --- a/temporalcli/commandsgen/commands.yml +++ b/temporalcli/commandsgen/commands.yml @@ -317,8 +317,8 @@ commands: | | | Please note: | | - Wrap attributes with backticks if it contains characters not in | - | `[a-zA-Z0-9]`. | - | - `STARTS_WITH` is only available for Keyword search attributes. | + | [a-zA-Z0-9]. | + | - STARTS_WITH is only available for Keyword search attributes. | +----------------------------------------------------------------------------+ ``` @@ -3334,4 +3334,4 @@ option-sets: description: | An external Nexus Endpoint that receives forwarded Nexus requests. May be used as an alternative to `--target-namespace` and - `--target-task-queue`. \ No newline at end of file + `--target-task-queue`.