gitlab

README

gitlab

gitlab://user:personal-access-token@gitlab_url/project_id/path#ref

URL Query	WithInstance Config	Description
user		The username of the user connecting
personal-access-token		An access token from Gitlab (https://<gitlab_url>/profile/personal_access_tokens)
gitlab_url		url of the gitlab server
project_id		id of the repository
path		path in repo to migrations
ref		(optional) can be a SHA, branch, or tag

Documentation

Index

• Constants
• Variables
• func WithInstance(client *gitlab.Client, config *Config) (source.Driver, error)
• type Config
• type Gitlab
  • func (g *Gitlab) Close() error
  • func (g *Gitlab) First() (version uint, er error)
  • func (g *Gitlab) Next(version uint) (nextVersion uint, err error)
  • func (g *Gitlab) Open(url string) (source.Driver, error)
  • func (g *Gitlab) Prev(version uint) (prevVersion uint, err error)
  • func (g *Gitlab) ReadAny(relativeFilepath string) (io.ReadCloser, error)
  • func (g *Gitlab) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)
  • func (g *Gitlab) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)

Constants

const DefaultMaxItemsPerPage = 100

Variables

var (
	ErrNoUserInfo       = fmt.Errorf("no username:token provided")
	ErrNoAccessToken    = fmt.Errorf("no access token")
	ErrInvalidHost      = fmt.Errorf("invalid host")
	ErrInvalidProjectID = fmt.Errorf("invalid project id")
	ErrInvalidResponse  = fmt.Errorf("invalid response")
)

Functions

func WithInstance

func WithInstance(client *gitlab.Client, config *Config) (source.Driver, error)

Types

type Config

type Config struct {
}

type Gitlab

type Gitlab struct {
	// contains filtered or unexported fields
}

func (*Gitlab) Close

func (g *Gitlab) Close() error

func (*Gitlab) First

func (g *Gitlab) First() (version uint, er error)

func (*Gitlab) Next

func (g *Gitlab) Next(version uint) (nextVersion uint, err error)

func (*Gitlab) Open

func (g *Gitlab) Open(url string) (source.Driver, error)

func (*Gitlab) Prev

func (g *Gitlab) Prev(version uint) (prevVersion uint, err error)

func (*Gitlab) ReadAny

func (g *Gitlab) ReadAny(relativeFilepath string) (io.ReadCloser, error)

This source driver does not support ReadAny.

func (*Gitlab) ReadDown

func (g *Gitlab) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)

func (*Gitlab) ReadUp

func (g *Gitlab) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)