projectref

type Info ¶

type Info struct {
	Organization Organization `yaml:"organization"`
	Project      Project      `yaml:"project"`
}

Info is the on-disk record written by `circleci project link`.

Schema:

organization:
  id: <uuid>          # required
  name: <string>      # optional, populated from API when available
project:
  id: <uuid>          # required
  slug: <string>      # required — VCS-style or canonical "circleci/<orgID>/<projectID>"
  name: <string>      # optional, populated from API when available

Project.Slug is always populated. Organization.ID and Project.ID are also populated when the slug was verified against the CircleCI API at link time; they let callers reference the project by its stable UUID even after a repo rename.

func Read(workDir string) (*Info, error)

func (i *Info) EffectiveSlug() string

type Organization ¶

type Organization struct {
	ID   string `yaml:"id,omitempty"`
	Name string `yaml:"name,omitempty"`
}

Organization is the CircleCI organization that owns the project.

type Project ¶

type Project struct {
	ID   string `yaml:"id,omitempty"`
	Slug string `yaml:"slug"`
	Name string `yaml:"name,omitempty"`
}

Project identifies a CircleCI project.