deploylink

package

v0.9.2 Latest Latest Go to latest Published: Nov 6, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/GLINCKER/levelrail

Links

Open Source Insights

Documentation ¶

Overview ¶

Package deploylink validates and builds "Deploy to Levelrail" links for git repositories and templates. The dashboard mirrors these rules in web/src/lib/deployLink.ts, and both run the cases in testdata/cases.json.

Index ¶

Constants
func HTML(alt, link, badge string) string
func Markdown(alt, link, badge string) string
func ParsePort(s string) (int, error)
func ValidateBranch(s string) error
func ValidateName(s string) error
func ValidateRepo(s string) error
func ValidateTemplate(s string) error
type Params

Constants ¶

View Source

const Path = "/deploy"

Path is the dashboard route a link opens.

Variables ¶

This section is empty.

Functions ¶

func HTML ¶

func HTML(alt, link, badge string) string

HTML is the README snippet for a link and a badge image URL.

func Markdown ¶

func Markdown(alt, link, badge string) string

Markdown is the README snippet for a link and a badge image URL.

func ParsePort ¶

func ParsePort(s string) (int, error)

ParsePort parses a decimal port in 1 to 65535.

func ValidateBranch ¶

func ValidateBranch(s string) error

ValidateBranch accepts a plain branch or tag name.

func ValidateName ¶

func ValidateName(s string) error

ValidateName accepts a DNS label.

func ValidateRepo ¶

func ValidateRepo(s string) error

ValidateRepo accepts https and ssh git URLs without credentials.

func ValidateTemplate ¶

func ValidateTemplate(s string) error

ValidateTemplate checks the shape of a catalog template id. Whether the id exists is checked by whoever holds the catalog.

Types ¶

type Params ¶

type Params struct {
	Repo     string
	Branch   string
	Name     string
	Template string
	Port     int
}

Params are the values a link may carry. Env values and secrets are never part of a link, so there is deliberately no field for them.

func (Params) Query ¶

func (p Params) Query() string

Query returns the encoded query in a fixed parameter order.

func (Params) URL ¶

func (p Params) URL(instance string) (string, error)

URL builds the link for an instance base URL such as https://lr.example.com.

func (Params) Validate ¶

func (p Params) Validate() error

Validate checks every set field. A link needs a repo or a template, not both.

Source Files ¶

View all Source files

deploylink.go

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