Github Action

actions allows to specify the accepted Composite Action names

A Composite Action is identified by an “action.yaml” or “action.yml” file, and the pattern is matched against the name of the directory containing it.

default:

  - "*",

Credentials allows to specify the credentials to use to authenticate to the git provider The ID of the credential must be the domain of the git provider to configure

default: empty

examples:

  autodiscovery:
    crawlers:
      github/action:
        credentials:
          "code.forgejo.com":
            kind: gitea
            token: xxx
          "github.com":
            kind: github
            token: '{{ requiredEnv "GITHUB_TOKEN" }}'

Expiration represents the token expiration time in seconds The token is used during the entire execution of updatecli and should be valid for the entire duration of the run The minimum value is 600 seconds (10 minutes)

Default: 3600 (1 hour)

password specifies the container registry password to use for authentication. Not compatible with token

compatible: * source * condition * target

default: by default credentials are fetch from the local environment such as ~/.docker/config.json.

remark: Not compatible with token

token specifies the container registry token to use for authentication.

compatible: * source * condition * target

default: by default credentials are fetch from the local environment such as ~/.docker/config.json.

remark: Not compatible with username/password

username specifies the container registry username to use for authentication.

compatible: * source * condition * target

default: by default credentials are fetch from the local environment such as ~/.docker/config.json.

remark: Not compatible with token

Digest provides parameters to specify if the generated manifest should use a digest instead of the branch or tag.

Remark: - The digest is only supported for GitHub Action and docker image tag update. Feel free to open an issue for the Gitea and Forgejo integration.

files allows to specify the accepted Action workflow file name

The pattern is matched against the file name only, not against its path, so a pattern such as “.github/workflows/*.yaml” never matches. The directory is constrained separately: a workflow file must sit directly inside a “workflows” directory whose parent is “.github”, “.gitea”, or “.forgejo”.

default:

  - "*.yaml",
  - "*.yml",

ignore allows to specify rule to ignore autodiscovery a specific GitHub action based on a rule

default: empty

Actions specifies the list of artifacts to check

The key is the artifact name and the value is the artifact version

The artifact name must match the GitHub action name or the Docker image name. In case of a Docker image, it must have the prefix docker://

If the value is empty, then the artifact name is enough to match If the value is a valid Git branch, Git tag, release, a Docker image tag , then the artifact version must match the constraint

only allows to specify rule to only autodiscover manifest for a specific GitHub action based on a rule

default: empty

Actions specifies the list of artifacts to check

The key is the artifact name and the value is the artifact version

The artifact name must match the GitHub action name or the Docker image name. In case of a Docker image, it must have the prefix docker://

If the value is empty, then the artifact name is enough to match If the value is a valid Git branch, Git tag, release, a Docker image tag , then the artifact version must match the constraint

rootDir allows to specify the root directory from where looking for GitHub Action

default: empty

versionfilter provides parameters to specify the version pattern used when generating manifest.

kind - semver versionfilter of kind semver uses semantic versioning as version filtering pattern accepts one of: prerelease - Updatecli tries to identify the latest prerelease whatever it means patch - Updatecli only handles patch version update minor - Updatecli handles patch AND minor version update minoronly - Updatecli handles minor version only major - Updatecli handles patch, minor, AND major version update majoronly - Updatecli only handles major version update a version constraint such as >= 1.0.0

kind - regex versionfilter of kind regex uses regular expression as version filtering pattern accepts a valid regular expression

example:

  versionfilter:
    kind: semver
    pattern: minor

and its type like regex, semver, or just latest.

More examples can be found at https://www.updatecli.io/docs/core/versionfilter/