Skip to content

Commit

Permalink
docs: fix refs to stopStrategy.expression (#13896)
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Rodriguez-Fernandez <[email protected]>
  • Loading branch information
carlosrodfern authored Nov 13, 2024
1 parent 217b598 commit f73e7f9
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion api/jsonschema/schema.json

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

2 changes: 1 addition & 1 deletion api/openapi-spec/swagger.json

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

4 changes: 2 additions & 2 deletions docs/cron-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,8 @@ The second will not run because of the `when` expression, which prevents this wo

> v3.6 and after

You can configure a `CronWorkflow` to automatically stop based on an [expression](variables.md#expression) with `stopStrategy.condition`.
You can use the [variables](variables.md#cronworkflows) `cronworkflow.failed` and `cronworkflow.succeede2d`.
You can configure a `CronWorkflow` to automatically stop based on an [expression](variables.md#expression) with `stopStrategy.expression`.
You can use the [variables](variables.md#cronworkflows) `cronworkflow.failed` and `cronworkflow.succeeded`.

For example, if you want to stop scheduling new workflows after one success:

Expand Down
2 changes: 1 addition & 1 deletion docs/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -1314,7 +1314,7 @@ CronWorkflowStatus is the status of a CronWorkflow
|`conditions`|`Array<`[`Condition`](#condition)`>`|Conditions is a list of conditions the CronWorkflow may have|
|`failed`|`integer`|v3.6 and after: Failed counts how many times child workflows failed|
|`lastScheduledTime`|[`Time`](#time)|LastScheduleTime is the last time the CronWorkflow was scheduled|
|`phase`|`string`|v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true|
|`phase`|`string`|v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true|
|`succeeded`|`integer`|v3.6 and after: Succeeded counts how many times child workflows succeeded|

## WorkflowEventBindingSpec
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/cron_workflow_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ type CronWorkflowStatus struct {
Succeeded int64 `json:"succeeded" protobuf:"varint,4,rep,name=succeeded"`
// v3.6 and after: Failed counts how many times child workflows failed
Failed int64 `json:"failed" protobuf:"varint,5,rep,name=failed"`
// v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true
// v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true
Phase CronWorkflowPhase `json:"phase" protobuf:"varint,6,rep,name=phase"`
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/generated.proto

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

2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/openapi_generated.go

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

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

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

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

0 comments on commit f73e7f9

Please sign in to comment.