preparation

Documentation

Overview

Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package preparation provides functionality to extract tags, branches and commits from repository configurations.

Index

• type Checker
• type Result
• type Stage
  • func (s *Stage) Run(ctx context.Context, cfgs []*config.RepoConfig) error

Types

type Checker

type Checker interface {
	Exists(ctx context.Context, addr string, hashType string, hash plumbing.Hash) (bool, error)
}

Checker interface is used to check whether a name/hash pair already exists in storage.

type Result

type Result struct {
	Name              string
	BaseCPE           string
	CheckoutOptions   *git.CheckoutOptions
	Commit            plumbing.Hash
	Reference         plumbing.Hash
	CommitTag         string
	When              time.Time
	Type              string
	Addr              string
	FileExts          []string
	EmptyBucketBitmap []byte
	FileCount         int
}

Result is the data structure returned by the stage.

type Stage

type Stage struct {
	Checker Checker
	RepoHdl *storage.BucketHandle
	Output  *pubsub.Topic
}

Stage holds the data types necessary to process repository configuration.

func (*Stage) Run

func (s *Stage) Run(ctx context.Context, cfgs []*config.RepoConfig) error

Run runs the stage and outputs Result data types to the results channel.