github

package
v0.17.1 Latest Latest
Warning

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

 Go to latest Published: Mar 31, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EnablePages 

func EnablePages(owner, repo string) error

EnablePages enables GitHub Pages on a repository with workflow-based deployment. Uses the `gh` CLI which handles authentication via existing user session.

func PagesEndpoint 

func PagesEndpoint(owner string) string

PagesEndpoint returns the canonical GitHub Pages hostname for an organization. e.g., "vitruviansoftware" → "vitruviansoftware.github.io"

func RepoInfo 

func RepoInfo() (owner, repo string, err error)

RepoInfo extracts the owner and repo name from the current git working directory.

func SetCustomDomain added in v0.17.1 

func SetCustomDomain(owner, repo, domain string) error

SetCustomDomain configures the custom domain on GitHub Pages and triggers SSL certificate provisioning via Let's Encrypt. Requires the domain to be verified at the org level first (done via GitHub UI).

Types

type DomainNotVerifiedError added in v0.17.1 

type DomainNotVerifiedError struct {
	Domain string
	Owner  string
}

DomainNotVerifiedError indicates the domain needs org-level verification in GitHub UI.

func (*DomainNotVerifiedError) Error added in v0.17.1 

func (e *DomainNotVerifiedError) Error() string

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.