Skip to content

Commit

Permalink
Merge pull request #3 from MarathonLabs/feature/max-version-for-v1
Browse files Browse the repository at this point in the history
feat(latest): fix latest to 0.3.11 for setup-marathon-cloud@v1
  • Loading branch information
Malinskiy authored Feb 4, 2024
2 parents 9205d2f + fd6c2ac commit bfcada4
Show file tree
Hide file tree
Showing 9 changed files with 3,189 additions and 11,381 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/unit-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16
node-version: 20
- run: npm ci
- run: npm run test-ci
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This action helps you to setup [marathon-cloud][] in your GitHub Actions workflo

| Name | Description | Default | Example |
| :---------------------: | --------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| `version` (optional) | The version of to use. Please see the following section [marathon-cloud version](#marathon-cloud-version) for details. | `latest` | `0.1.1` |
| `version` (optional) | The version of to use. Please see the following section [marathon-cloud version](#marathon-cloud-version) for details. | `latest` | `0.3.11` |
| `skip-cache` (optional) | Skip discovering the marathon-cloud from cache. By setting this to true will force to download the marathon-cloud from GitHub releases. | `false` | `true` |

## Usage Examples
Expand All @@ -16,13 +16,14 @@ This action helps you to setup [marathon-cloud][] in your GitHub Actions workflo
```yaml
- uses: MarathonLabs/[email protected]
with:
version: "0.1.1"
version: "0.3.11"
```
### Use Latest Version
> **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 @@ -40,13 +41,22 @@ This action helps you to setup [marathon-cloud][] in your GitHub Actions workflo
```yaml
- uses: MarathonLabs/[email protected]
with:
version: "0.1.1"
version: "0.3.11"
skip-cache: "true"
```
## 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 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
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ branding:
icon: "download-cloud"
color: "purple"
runs:
using: "node16"
using: "node20"
main: "lib/index.js"
Loading

0 comments on commit bfcada4

Please sign in to comment.