Updatecli Github Action

• Usage
  • Workflow
• Deprecation
• License

Usage

Install Updatecli for GitHub Action

Options

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

• 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: updateclion:
workflow_dispatch:
schedule:
# * is a special character in YAML so you have to quote this string# Run once a day
- cron: '0 0 * * *'# Please note that you need to allow Github Action tokens to# create pull requests in the repository settings, too:# Go to the Repository Settings → "Actions" → "General" → "Workflow permissions"# and enable "Allow GitHub Actions to create and approve pull requests"permissions:
contents: writepull-requests: writejobs:
updatecli:
runs-on: ubuntu-lateststeps:
- name: Checkoutuses: actions/checkout@v7.0.1
- name: Install Updatecli in the runneruses: updatecli/updatecli-action@v3.5.0
- name: Run Updatecli in Dry Run moderun: updatecli diffenv:
UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Run Updatecli in Apply moderun: updatecli apply --config updatecli/updatecli.denv:
UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Please check whether you need to allow Github Action tokens to create pull requests in the repository settings in addition to granting write permissions in the workflow. This is required by GitHub in new repositories.

Go to the Repository Settings → "Actions" → "General" → "Workflow permissions" and enable "Allow GitHub Actions to create and approve pull requests"

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

Deprecation

Important

The branch v1 and v2 are deprecated and will be remove soon. You should use GitHub action version instead (or track the main branch if you really want to). You can migrate to the latest GitHub action version using the following Updatecli policy:

.updatecli-compose.yaml

# export UPDATECLI_GITHUB_TOKEN=<insert PAT>
# export UPDATECLI_GITHUB_USERNAME=<insert username>
# updatecli compose diff --file updatecli-compose.yaml
# updatecli compose apply --file updatecli-compose.yaml
valuesinline:
scm:
enabled: true
kind: githubsearch
search: |
org:<replace with your GitHub organization>
archived:false
branch: "^main$|^master$" # branch accept regular expression
email: <email associatedi with the git commits>
limit: 0 # zero means no repository limit
policies:
- name: Update Updatecli GitHub action version
policy: ghcr.io/updatecli/policies/updatecli/githubaction:0.8.1

License

MIT. See LICENSE for more details.