This action helps you to setup marathon-cloud in your GitHub Actions workflow.

- uses: MarathonLabs/[email protected]
  with:
    version: "0.3.11"

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

- uses: MarathonLabs/[email protected]
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    version: "latest"

NOTE This option is designed for testing purpose.

- uses: MarathonLabs/[email protected]
  with:
    version: "0.3.11"
    skip-cache: "true"

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:

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.

The action source is located at /src. The action is written in TypeScript and compiled to a single javascript file with ncc. It's expected to checkin lib/index.js to the repository.

To setup the development environment, run the following commands:

$ npm install

To build the action script, run the following command:

$ npm run build

To test the action, we can use the workflow Test workflow to trigger a build.

MIT