ciexamples

package
v0.9.2 Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package ciexamples embeds the CI pipeline examples under docs/ci-examples, so the dashboard, CLI and API serve exactly the files the documentation links to.

Index

Constants

View Source 
const (
	AuthOIDC  = "oidc"
	AuthToken = "token"
)

Auth modes: oidc swaps the job identity for a short-lived token, token uses a stored deployer token.

View Source 
const AppPlaceholder = "my-app"

AppPlaceholder is the app name used in every example; Content swaps it for the real app. Repository owners stay as OWNER/REPO so a pasted file can never name a real account.

Variables

This section is empty.

Functions

func Content 

func Content(t Template, app string) (string, error)

Content returns the example text with the placeholder app name replaced by app.

Types

type Template 

type Template struct {
	ID     string `json:"id"`
	File   string `json:"file"`
	Target string `json:"target"`
	Auth   string `json:"auth"`
}

Template is one provider's example pipeline.

func Templates 

func Templates() ([]Template, error)

Templates lists the examples in manifest order.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.