Gitea

Gitea scm

Description

The Gitea scm plugin is used to manage git repositories hosted on Gitea, depending on the stage, it can be used for different purposes

source: Retrieve data from a git repository, such as a file content condition: Ensure data exist on a git repository, such as a file content target: Ensure data is up to date on a git repository

Parameters

NameTypeDescriptionRequired
branchstringBranch specifies which Gitea repository branch to work on
commitmessageobjectCommitMessage represents conventional commit metadata as type or scope, used to generate the final commit message.
    bodystringDefine commit body
    footersstringDefine commit footer
    hidecreditbooleanDisplay updatecli credits inside commit message body
    scopestringDefine commit type scope
    titlestringDefine commit title
    typestringDefine commit type, like chore, fix, etc
directorystringDirectory specifies where the github repository is cloned on the local disk
emailstringEmail specifies which emails to use when creating commits
forcebooleanForce is used during the git push phase to run `git push --force`.
gpgobjectGPG key and passphrased used for commit signing
    passphrasestringDefine the gpg passphrase
    signingkeystringDefines the gpg key
ownerstringOwner specifies repository owner
repositorystringRepository specifies the name of a repository for a specific owner
tokenstring[S][C][T] Token specifies the credential used to authenticate with
urlstring[S][C][T] URL specifies the default github url in case of Gitea enterprise
userstringUser specifies the user of the git commit messages
usernamestring[S][C][T] Username specifies the username used to authenticate with Gitea API

CommitMessage

Updatecli uses conventional commits as describe on www.conventionnalcommits.org.
The goal is to add human and machine readable meaning to commit messages

By default, Updatecli generates a commit message using the default type "chore" and split long title message into the body like:


Author: olblak <updatecli@updatecli.io>
Date:   Tue May 4 15:41:44 2021 +0200

    chore: Update key "dependencies[0].version" from file "charts/jenkins/r...

    ... equirements.yaml"

    Made with ❤️️  by updatecli

NameRequiredDefaultDescription

type

chore

Specify commit type

scope

Specify commit scope

footer

Specify commit footer message

title

Override default body message

hideCredit

Remove "Made with ❤️️ by updatecli" from commit message

body

Override default body message

GPG

Updatecli can sign commits using a private GPG key if configured accordingly.


NameRequiredDefaultDescription

signingkey

Defines the armored private gpg key

password

Defines the gpg key password

Example

# updatecli.yaml
---
name: Test Gitea scm

scms:
  gitea:
    kind: gitea
    spec:
      url: "try.gitea.io"
      owner: "olblak"
      repository: "updatecli-mirror"
      branch: main

sources:
  license:
    name: Retrieve license file content
    kind: file
    scmid: gitea
    spec:
      file: LICENSE

Top