github

Documentation

Overview

Package github provides the ability for Vela to integrate with GitHub or GitHub Enterprise as a template registry.

Usage:

import "github.com/go-vela/server/compiler/registry/github"

Index

• type Client
  • func New(ctx context.Context, address, token string) (*Client, error)
  • func (c *Client) Equal(other *Client) bool
  • func (c *Client) Parse(path string) (*registry.Source, error)
  • func (c *Client) Template(ctx context.Context, u *api.User, s *registry.Source) ([]byte, error)

Types

type Client

type Client struct {
	URL string
	API string
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, address, token string) (*Client, error)

New returns a Registry implementation that integrates with GitHub or a GitHub Enterprise instance.

func (*Client) Equal

func (c *Client) Equal(other *Client) bool

func (*Client) Parse

func (c *Client) Parse(path string) (*registry.Source, error)

Parse creates the registry source object from a template path and default branch.

func (*Client) Template

func (c *Client) Template(ctx context.Context, u *api.User, s *registry.Source) ([]byte, error)

Template captures the templated pipeline configuration from the GitHub repo.