Skip to content

updatecli/updatecli-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Updatecli Github Action

Usage

Install Updatecli for GitHub Action

Options

  • version: Specify the Updatecli version to install. Accepted values are any valid releases such as v0.86.1.

  • version-file: The path to a file containing updatecli version. Supported file types are .updatecli-version and .tool-versions. See more details in about version-file.

Updatecli version file

If the version-file input is specified, the action will extract the version from the file and install it.

Supported files are .updatecli-version and .tool-versions. In .updatecli-version file, only the version should be specified (e.g., v0.86.1). In .tool-versions file, updatecli version should be preceded by the updatecli keyword (e.g., updatecli v0.86.1). The .tool-versions file supports version specifications in accordance with Semantic Versioning (semver).

If both version and version-file inputs are provided, the version input will be used.

If the file contains multiple versions, only the first one will be recognized.

Workflow

name: updatecli on: workflow_dispatch: schedule: # * is a special character in YAML so you have to quote this string # Run once a day - cron: '0 0 * * *' permissions: contents: write pull-requests: write jobs: updatecli: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: Install Updatecli in the runner uses: updatecli/updatecli-action@v2 - name: Run Updatecli in Dry Run mode run: updatecli diff env: UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Run Updatecli in Apply mode run: updatecli apply --config updatecli/updatecli.d env: UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

WARNING: Dont enable --debug mode in Github Action as it may leak information.

License

MIT. See LICENSE for more details.