Updatecli Github Action

Usage

Updatecli version file

Workflow

Manual setup

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 * * *'

# 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: write
  pull-requests: write

jobs:
  updatecli:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/[email protected]

      - name: Install Updatecli in the runner
        uses: updatecli/[email protected]

      - name: Run Updatecli in Dry Run mode
        run: updatecli pipeline diff --config updatecli/updatecli.d
        env:
          UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Run Updatecli in Apply mode
        run: updatecli pipeline apply --config updatecli/updatecli.d
        env:
          UPDATECLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Warning

Do not enable --debug mode in GitHub Actions as it may leak information.

Scaffold the workflows with an Updatecli policy

# The policy reads its token from GITHUB_TOKEN, configurable with the scm.env_token value
export GITHUB_TOKEN=<PAT with the repo and workflow scopes>

# To show what would be created
updatecli diff ghcr.io/updatecli/policies/updatecli/githubaction/scaffold:0.2.0
# To apply the changes if you are happy with the diff
updatecli apply ghcr.io/updatecli/policies/updatecli/githubaction/scaffold:0.2.0

Keep the workflows up to date

# export GITHUB_TOKEN=<PAT with the repo and workflow scopes>
# export UPDATECLI_GITHUB_TOKEN=<PAT used by your own manifests>
# updatecli compose diff
# updatecli compose apply

name: Default Updatecli Policies

valuesinline:
  scm:
    enabled: true
    user: updatecli
    email: [email protected]
    owner: <replace with your GitHub organization>
    repository: <replace with your GitHub repository>
    username: "updatecli-bot"
    branch: main

policies:
  - name: Local Updatecli policies
    id: local
    config:
      - updatecli/updatecli.d

  - name: Configure Updatecli workflows
    id: updatecli
    policy: ghcr.io/updatecli/policies/updatecli/githubaction/scaffold:0.2.0
    valuesinline:
      gha:
        # Credentials referenced by the generated workflows
        #   token -> secrets.GITHUB_TOKEN, works with no further setup
        #   app   -> UPDATECLIBOT_APP_* secrets, the default, used by the Updatecli project itself
        auth: token
        udash:
          # Reports the pipeline results to Udash, requires the UPDATECLI_UDASH_* secrets
          enabled: false
        apply:
          # Opens new pull requests, default "0 12 */14 * *"
          cron: "0 12 */14 * *"
        update:
          # Refreshes the existing ones, default "0 1 * * *"
          cron: "0 3 * * *"
          matrix:
            - target_name: "existing pipelines"
              apply_args: "--existing-only=true"
            # Only useful if you label your manifests with "monitor: active"
            - target_name: "monitored pipelines"
              apply_args: "--labels=monitor:active"

Deprecation

Important

The branch v1 and v2 are deprecated and will be removed at some point. 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:

# 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.10.0

License