template

Documentation

Index

• func Get(path string) (string, error)
• func Render(tmplContent string, data any) (string, error)
• func WriteFile(tmplContent, dst string, data any, overwrite bool) error
• type BundleInitOptions
• type TestInitOptions

Functions

func Get

func Get(path string) (string, error)

Get returns the content of an embedded template file. path is relative to the files/ directory, e.g. "query/cpp/new-query.tmpl".

func Render

func Render(tmplContent string, data any) (string, error)

Render executes a template string with [[ ]] delimiters and the given data. [[ ]] delimiters are used to avoid conflicts with GitHub Actions {{ }} syntax.

func WriteFile

func WriteFile(tmplContent, dst string, data any, overwrite bool) error

WriteFile renders a template string and writes the output to dst. If overwrite is false and dst already exists, the write is skipped.

Types

type BundleInitOptions

type BundleInitOptions struct {
	Languages []string
	Branch    string
	// Packs is the list of pack names from qlt.conf.json with Bundle: true.
	// They are passed to github/codeql-action/init via its `config.packs` input.
	Packs []string
}

BundleInitOptions holds template variables for bundle init.

type TestInitOptions

type TestInitOptions struct {
	Language   string // display name used in the workflow title and filename
	LangFlag   string // value for --language flag; empty means test all languages
	Branch     string
	NumThreads int
	UseRunner  string
	CodeqlArgs string
}

TestInitOptions holds template variables for the test init workflow.