autodiscovery

package

v0.9.1 Latest Latest Go to latest Published: Dec 1, 2023 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

package autodiscovery is an implementation of the VCS Autodiscovery RFC.

This section is empty.

This section is empty.

func Kind(kind string) (func(url, defaultBranch string) VCS, error)

type Forge struct {
	RawFile string
	File    string
	Dir     string
	Summary string
	Line    string
}

Forge indicates the links used to navigate around the software forge.

type VCS struct {
	Type          string
	DefaultBranch string
	Clone         []string
	Forge         Forge
}

VCS represents the Version Control System being used.

func Forgejo(url, defaultBranch string) VCS

Forgejo generates VCS for forgejo. For instance "https://codeberg.org/pfad.fr/vanitydoc" and defaultBranch "main".

func Github(url, defaultBranch string) VCS

Github generates VCS for github. For instance "https://github.com/fluhus/godoc-tricks" and defaultBranch "main".

func SourceHutGit(url, defaultBranch string) VCS

SourceHutGit generates VCS for git.sr.ht. For instance "https://git.sr.ht/~username/repo" and defaultBranch "main".

func (vcs VCS) GoImport(wr io.Writer, importPrefix string) error

GoImport writes the go-import meta tag.

func (vcs VCS) MetaTags(wr io.Writer) error

MetaTags writes the VCS Autodiscovery RFC meta tags (which are not empty).