Skip to content

Commit

Permalink
fix(readme): clarify latest version
Browse files Browse the repository at this point in the history
  • Loading branch information
Malinskiy committed Feb 4, 2024
1 parent 7c23153 commit fd6c2ac
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This action helps you to setup [marathon-cloud][] in your GitHub Actions workflo
> **NOTE**
> We recommend to use a specific version of marathon-cloud to have consistent behavior.
> If you choose to use latest with v1 action then it will use latest supported version for v1 which is 0.3.11
```yaml
- uses: MarathonLabs/[email protected]
Expand All @@ -47,12 +48,13 @@ This action helps you to setup [marathon-cloud][] in your GitHub Actions workflo
## marathon-cloud version
If the `version` is not set, or is one of `latest` or `*`, the action will try to use the latest version of marathon-cloud.
For `v1` action the latest supported version is 0.3.11. Any version starting with 1.0.0 will be incompatible.

Support matrix:
| action version | cli version |
|---------------- | ------------ |
| v2 | 1.0.0..2.0.0 |
| v1 | <1.0.0 |
| action version | cli version supported | `latest` version |
|---------------- | ---------------------- | ---------------- |
| v2 | 1.0.0..2.0.0 | not supported |
| v1 | <1.0.0 | 0.3.11 |


However, due to the GitHub API rate limiting settings, this action requires to pass in the `GITHUB_TOKEN` to the environment variable. If this environment variable is not set, one will see error similar to the following:
Expand Down

0 comments on commit fd6c2ac

Please sign in to comment.