Skip to content

Commit 7a54bc8

Browse files
committed
Sync open source content 🐝 (from a8cb711d0eef786d52cc8a9f566103a8b61d29ae)
1 parent 7d00f34 commit 7a54bc8

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

docs/speakeasy-reference/workflow-file.mdx

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,27 @@ A Target is a SDK, Terraform or other generated artifact from sources.
2727

2828
## Speakeasy Version
2929

30-
The version of the Speakeasy CLI to use to run the workflow. The version can be a specific version or `latest` to use the latest version.
31-
Pinning to a specific version can be useful to ensure that the workflow runs consistently across different environments.
30+
The version of the Speakeasy CLI to use to run the workflow. The `speakeasyVersion` field accepts three types of values:
31+
32+
- **`latest`**: The Speakeasy CLI will perform a blue/green attempted upgrade to the latest version of the CLI. If there is a failure in generation, it will always re-run on the last successful version. This is the default and always tries to bring in generator upgrades (for example, to dependencies) where those changes compile, lint successfully, and pass tests successfully.
33+
34+
- **`pinned`**: The Speakeasy CLI will always execute on the installed version and won't attempt to change versions. This can be useful for teams with alternative automation to control the Speakeasy CLI version (for example, using [mise](https://mise.jdx.dev/)).
35+
36+
- **A specific version** (for example, `1.493.1`): The Speakeasy CLI will always run on this exact version. This can be useful for teams with stringent change management procedures. Available versions correspond to [Speakeasy CLI releases](https://github.com/speakeasy-api/speakeasy/releases).
37+
38+
```yaml
39+
workflowVersion: 1.0.0
40+
speakeasyVersion: latest
41+
```
42+
43+
```yaml
44+
workflowVersion: 1.0.0
45+
speakeasyVersion: pinned
46+
```
3247
3348
```yaml
3449
workflowVersion: 1.0.0
35-
speakeasyVersion: v1.250.0
50+
speakeasyVersion: 1.493.1
3651
```
3752
3853
## Sources

0 commit comments

Comments
 (0)