Gitea Branch

kind: gitea/branch

sourceconditiontarget

✔

✔

✗

Description

The Gitea "branch" plugin allows to manipulate Gitea repository branches.

source

When used as a "source", the Gitea branch plugin allows to get a Gitea repository branch according the version filter rule provided.

condition

When used as a "condition". the Gitea branch plugin allows to test that specific Gitea branch exist.

target

Target is not supported, feel free to manifest your interest by opening an issue on updatecil/updatecli/issues, or highlighting an existing one.

Parameters

NameTypeDescriptionRequired
branchstring[C] Branch specifies the branch name
ownerstring[S][C] Owner specifies repository owner
repositorystring[S][C] Repository specifies the name of a repository for a specific owner
tokenstring

“token” specifies the credential used to authenticate with Gitea API

remark: A token is a sensitive information, it’s recommended to not set this value directly in the configuration file but to use an environment variable or a SOPS file.

The value can be set to {{ requiredEnv "GITEA_TOKEN"}} to retrieve the token from the environment variable GITHUB_TOKEN or {{ .gitea.token }} to retrieve the token from a SOPS file.

  For more information, about a SOPS file, please refer to the following documentation:

https://github.com/getsops/sops

urlstring“url” defines the Gitea url to interact with
usernamestring“username” defines the username used to authenticate with Gitea API
versionfilterobject[S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
    kindstringspecifies the version kind such as semver, regex, or latest
    patternstringspecifies the version pattern according the version kind
    strictbooleanstrict enforce strict versioning rule. Only used for semantic versioning at this time

Example

# updatecli.yaml
name: "Test Gitea branch"

sources:
  default:
    kind: "gitea/branch"
    spec:
      url: "try.gitea.io"
      owner: "olblak"
      repository: "updatecli-test"
      branch: main

conditions:
  default:
    name: Show condition usage without source input
    kind: "gitea/branch"
    disablesourceinput: true
    spec:
      url: "try.gitea.io"
      owner: "olblak"
      repository: "updatecli-test"
      branch: "main"

  sourcedefault:
    name: Show condition using branch name fetch from source input
    kind: "gitea/branch"
    sourceid: "default"
    spec:
      url: "try.gitea.io"
      owner: "olblak"
      repository: "updatecli-test"
Last modified on August 24, 2022
Edit this page on GitHub
← NPM
Gitea Release →