config

Documentation

Overview

Package config defines configuration settings for extracting compilation records from a repository using a non-bazel build system.

Index

• Constants
• func ExtractRepo(ctx context.Context, repo Repo) error
• func GitClone(ctx context.Context, repo, outputPath string) error
• type Extractor
• type Repo
  • func (r Repo) Clone(ctx context.Context, tmpDir string) error

Constants

const (
	// DefaultRepoVolume The default volume name containing the repo.
	DefaultRepoVolume = "/repo"

	// DefaultOutputVolume The default volume name containing the extraction output.
	DefaultOutputVolume = "/out"
)

Functions

func ExtractRepo

func ExtractRepo(ctx context.Context, repo Repo) error

ExtractRepo extracts a given code repository and outputs kindex files.

It makes a local clone of the repository. It optionally uses a passed extraction config, otherwise it attempts to find a Kythe config named ".kythe-extraction-config".

It builds a one-off customized Docker image for extraction, and then runs it, generating kindex files (format defined here: http://kythe.io/docs/kythe-index-pack.html).

This function requires both Git and Docker to be in $PATH during execution.

func GitClone

func GitClone(ctx context.Context, repo, outputPath string) error

GitClone is a convenience wrapper around a commandline git clone call.

Types

type Extractor

type Extractor func(ctx context.Context, repo Repo) error

Extractor is the interface for handling kindex generation on repos.

ExtractRepo takes an input repo, output path to a directory, and optional kythe.proto.ExtractionConfiguration file path, and performs kythe extraction on the repo, depositing results in the output directory path.

type Repo

type Repo struct {
	// Either GitRepo or LocalRepo should be set, not both.
	// A remote git repo, e.g. https://github.com/kythe/kythe.
	Git string

	// A local copy of a repository.
	Local string

	// Where to write from an extraction.
	OutputPath string

	// An optional path to a file containing a
	// kythe.proto.ExtractionConfiguration encoded as JSON that details how
	// to perform extraction. If this is unset, the extractor will first try
	// to find a config defined in the repo, or finally use a hard coded
	// default config.
	ConfigPath string

	// An optional temporary repo path to copy the input repo to.
	TempRepoDir string

	// An optional temporary directory path to write output before copying to
	// OutputPath.
	TempOutDir string
}

Repo is a container of input/output parameters for doing extraction on remote repositories.

func (Repo) Clone

func (r Repo) Clone(ctx context.Context, tmpDir string) error

Clone takes either the Git or Local repo and makes a copy of it.