Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Fix typo in schedule create example #640

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Fix typo in schedule create example #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ac9b6b
Fix typo in `schedule create` example
josh-berry Aug 20, 2024
2ddcf8d
Merge branch 'main' into josh/fix-typo-639
josh-berry Aug 20, 2024
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
4 changes: 2 additions & 2 deletions temporalcli/commands.gen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,9 +1055,9 @@ func NewTemporalScheduleCreateCommand(cctx *CommandContext, parent *TemporalSche
s.Command.Use = "create [flags]"
s.Command.Short = "Create a new Schedule"
if hasHighlighting {
s.Command.Long = "Create a new Schedule on the Temporal Service. A Schedule automatically starts\nnew Workflow Executions at the times you specify.\n\nFor example:\n\n\x1b[1m temporal schedule create \\\n --schedule-id \"YourScheduleId\" \\\n --calendar '{\"dayOfWeek\":\"Fri\",\"hour\":\"3\",\"minute\":\"30\"}' \\\n --workflow-id YourBaseWorkflowIdName \\\n --task-queue YourTaskQueue \\\n --workflow-type YourWorkflowType\x1b[0m\n\nSchedules support any combination of \x1b[1m--calendar\x1b[0m, \x1b[1m--interval\x1b[0m, and \x1b[1m--cron\x1b[0m:\n\n* Shorthand \x1b[1m--interval\x1b[0m strings.\n For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of\n the 5th hour).\n* JSON \x1b[1m--calendar\x1b[0m, as in the preceding example.\n* Unix-style \x1b[1m--cron\x1b[0m strings and robfig declarations\n (@daily/@weekly/@every X/etc).\n For example, every Friday at 12:30 PM: \x1b[1m30 12 * * Fri\x1b[0m."
s.Command.Long = "Create a new Schedule on the Temporal Service. A Schedule automatically starts\nnew Workflow Executions at the times you specify.\n\nFor example:\n\n\x1b[1m temporal schedule create \\\n --schedule-id \"YourScheduleId\" \\\n --calendar '{\"dayOfWeek\":\"Fri\",\"hour\":\"3\",\"minute\":\"30\"}' \\\n --workflow-id YourBaseWorkflowIdName \\\n --task-queue YourTaskQueue \\\n --type YourWorkflowType\x1b[0m\n\nSchedules support any combination of \x1b[1m--calendar\x1b[0m, \x1b[1m--interval\x1b[0m, and \x1b[1m--cron\x1b[0m:\n\n* Shorthand \x1b[1m--interval\x1b[0m strings.\n For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of\n the 5th hour).\n* JSON \x1b[1m--calendar\x1b[0m, as in the preceding example.\n* Unix-style \x1b[1m--cron\x1b[0m strings and robfig declarations\n (@daily/@weekly/@every X/etc).\n For example, every Friday at 12:30 PM: \x1b[1m30 12 * * Fri\x1b[0m."
} else {
s.Command.Long = "Create a new Schedule on the Temporal Service. A Schedule automatically starts\nnew Workflow Executions at the times you specify.\n\nFor example:\n\n```\n temporal schedule create \\\n --schedule-id \"YourScheduleId\" \\\n --calendar '{\"dayOfWeek\":\"Fri\",\"hour\":\"3\",\"minute\":\"30\"}' \\\n --workflow-id YourBaseWorkflowIdName \\\n --task-queue YourTaskQueue \\\n --workflow-type YourWorkflowType\n```\n\nSchedules support any combination of `--calendar`, `--interval`, and `--cron`:\n\n* Shorthand `--interval` strings.\n For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of\n the 5th hour).\n* JSON `--calendar`, as in the preceding example.\n* Unix-style `--cron` strings and robfig declarations\n (@daily/@weekly/@every X/etc).\n For example, every Friday at 12:30 PM: `30 12 * * Fri`."
s.Command.Long = "Create a new Schedule on the Temporal Service. A Schedule automatically starts\nnew Workflow Executions at the times you specify.\n\nFor example:\n\n```\n temporal schedule create \\\n --schedule-id \"YourScheduleId\" \\\n --calendar '{\"dayOfWeek\":\"Fri\",\"hour\":\"3\",\"minute\":\"30\"}' \\\n --workflow-id YourBaseWorkflowIdName \\\n --task-queue YourTaskQueue \\\n --type YourWorkflowType\n```\n\nSchedules support any combination of `--calendar`, `--interval`, and `--cron`:\n\n* Shorthand `--interval` strings.\n For example: 45m (every 45 minutes) or 6h/5h (every 6 hours, at the top of\n the 5th hour).\n* JSON `--calendar`, as in the preceding example.\n* Unix-style `--cron` strings and robfig declarations\n (@daily/@weekly/@every X/etc).\n For example, every Friday at 12:30 PM: `30 12 * * Fri`."
}
s.Command.Args = cobra.NoArgs
s.ScheduleConfigurationOptions.buildFlags(cctx, s.Command.Flags())
Expand Down
2 changes: 1 addition & 1 deletion temporalcli/commandsmd/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@ For example:
--calendar '{"dayOfWeek":"Fri","hour":"3","minute":"30"}' \
--workflow-id YourBaseWorkflowIdName \
--task-queue YourTaskQueue \
--workflow-type YourWorkflowType
--type YourWorkflowType
```

Schedules support any combination of `--calendar`, `--interval`, and `--cron`:
Expand Down
Loading