-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,31 +6,17 @@ 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.3.11` | | ||
| `version` (required) | 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 | ||
|
||
### Basic | ||
|
||
```yaml | ||
- uses: MarathonLabs/setup-marathon-cloud@1.0.0 | ||
- uses: MarathonLabs/setup-marathon-cloud@2 | ||
with: | ||
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] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
version: "latest" | ||
version: "1.0.0" | ||
``` | ||
### Skip Cache | ||
|
@@ -39,34 +25,25 @@ This action helps you to setup [marathon-cloud][] in your GitHub Actions workflo | |
> This option is designed for testing purpose. | ||
```yaml | ||
- uses: MarathonLabs/setup-marathon-cloud@1.0.0 | ||
- uses: MarathonLabs/setup-marathon-cloud@2 | ||
with: | ||
version: "0.3.11" | ||
version: "1.0.0" | ||
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 | | ||
|
||
Action version `2` supports cli version with major version `1`; | ||
Action version `1` supports cli versions up to 0.3.11. Any version starting with 1.0.0 will be incompatible. | ||
|
||
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: | ||
|
||
``` | ||
Run MarathonLabs/setup-marathon-cloud@{version} | ||
/home/runner/work/_actions/MarathonLabs/setup-marathon-cloud/{version}/lib/index.js:14812 | ||
throw new Error('GITHUB_TOKEN is not set, unable to resolve the latest version of marathon-cloud'); | ||
``` | ||
|
||
> **NOTE** | ||
> To ensure consistent behavior, it is recommended to specify the version of marathon-cloud to use. We can find the full list of available versions at [marathon-cloud releases][]. | ||
You can find the full list of available versions at [marathon-cloud releases][]. | ||
|
||
[marathon-cloud]: https://github.com/MarathonLabs/marathon-cloud-cli | ||
[marathon-cloud releases]: https://github.com/MarathonLabs/marathon-cloud-cli/releases | ||
|