client

package
v0.999.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client *scm.Client

func New

func New(s Spec) (Client, error)

type SDKClient added in v0.108.0

type SDKClient = *giteasdk.Client // new type for the gitea sdk client

Use type aliases instead of declaring new named pointer types so the method sets of the underlying SDK types are preserved.

func NewSDKClient added in v0.108.0

func NewSDKClient(s Spec) (SDKClient, error)

NewSDKClient creates a new Gitea client based on the official gitea sdk instead of drone's go-scm

type Spec

type Spec struct {
	//  "url" defines the Gitea url to interact with
	URL string `yaml:",omitempty" jsonschema:"required"`
	//  "username" defines the username used to authenticate with Gitea API
	Username string `yaml:",omitempty"`
	//  "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
	Token string `yaml:",omitempty"`
}

Spec defines a specification for a "gitea" resource parsed from an updatecli manifest file

func (*Spec) Sanitize

func (s *Spec) Sanitize() error

Sanitize parse and update if needed a spec content

func (Spec) Validate

func (s Spec) Validate() error

Validate validates that a spec contains good content

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL