recipespb

package
v0.0.0-...-01cd1ea Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package recipespb contains the protobuf definition for recipe.

Index

Constants

This section is empty.

Variables

View Source 
var (
	AutorollRecipeOptions_TrivialOptions_SelfApproveMethod_name = map[int32]string{
		0: "BOT_COMMIT_APPROVE",
		1: "CODE_REVIEW_1_APPROVE",
		2: "CODE_REVIEW_2_APPROVE",
		3: "NO_LABELS_APPROVE",
	}
	AutorollRecipeOptions_TrivialOptions_SelfApproveMethod_value = map[string]int32{
		"BOT_COMMIT_APPROVE":    0,
		"CODE_REVIEW_1_APPROVE": 1,
		"CODE_REVIEW_2_APPROVE": 2,
		"NO_LABELS_APPROVE":     3,
	}
)

Enum value maps for AutorollRecipeOptions_TrivialOptions_SelfApproveMethod.

View Source 
var File_go_chromium_org_luci_recipes_py_proto_recipes_cfg_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AutorollRecipeOptions 

type AutorollRecipeOptions struct {
	Trivial    *AutorollRecipeOptions_TrivialOptions    `protobuf:"bytes,1,opt,name=trivial,proto3" json:"trivial,omitempty"`
	Nontrivial *AutorollRecipeOptions_NontrivialOptions `protobuf:"bytes,2,opt,name=nontrivial,proto3" json:"nontrivial,omitempty"`
	// Make the autoroller skip this repo entirely with a human-readable message.
	DisableReason string `protobuf:"bytes,3,opt,name=disable_reason,json=disableReason,proto3" json:"disable_reason,omitempty"`
	// If true, skip the autoroller will skip CCing authors of CLs in this repo
	// when rolling those CLs downstream.
	NoCcAuthors bool `protobuf:"varint,4,opt,name=no_cc_authors,json=noCcAuthors,proto3" json:"no_cc_authors,omitempty"`
	// If true, don't use the --r-owner option to 'git cl upload'.
	NoOwners bool `protobuf:"varint,5,opt,name=no_owners,json=noOwners,proto3" json:"no_owners,omitempty"`
	// contains filtered or unexported fields
}

These options control the behavior of the autoroller recipe: 

https://chromium.googlesource.com/infra/infra/+/main/recipes/recipes/recipe_autoroller.py

func (*AutorollRecipeOptions) Descriptor deprecated 

func (*AutorollRecipeOptions) Descriptor() ([]byte, []int)

Deprecated: Use AutorollRecipeOptions.ProtoReflect.Descriptor instead.

func (*AutorollRecipeOptions) GetDisableReason 

func (x *AutorollRecipeOptions) GetDisableReason() string

func (*AutorollRecipeOptions) GetNoCcAuthors 

func (x *AutorollRecipeOptions) GetNoCcAuthors() bool

func (*AutorollRecipeOptions) GetNoOwners 

func (x *AutorollRecipeOptions) GetNoOwners() bool

func (*AutorollRecipeOptions) GetNontrivial 

func (x *AutorollRecipeOptions) GetNontrivial() *AutorollRecipeOptions_NontrivialOptions

func (*AutorollRecipeOptions) GetTrivial 

func (x *AutorollRecipeOptions) GetTrivial() *AutorollRecipeOptions_TrivialOptions

func (*AutorollRecipeOptions) ProtoMessage 

func (*AutorollRecipeOptions) ProtoMessage()

func (*AutorollRecipeOptions) ProtoReflect 

func (x *AutorollRecipeOptions) ProtoReflect() protoreflect.Message

func (*AutorollRecipeOptions) Reset 

func (x *AutorollRecipeOptions) Reset()

func (*AutorollRecipeOptions) String 

func (x *AutorollRecipeOptions) String() string

type AutorollRecipeOptions_NontrivialOptions 

type AutorollRecipeOptions_NontrivialOptions struct {

	// These add additional reviewer emails on the change.
	ExtraReviewerEmails []string `protobuf:"bytes,1,rep,name=extra_reviewer_emails,json=extraReviewerEmails,proto3" json:"extra_reviewer_emails,omitempty"`
	// If true, the autoroller recipe will automatically do a CQ dry run when
	// uploading the change.
	AutomaticCommitDryRun bool `` /* 129-byte string literal not displayed */
	// If true, the autoroller recipe will set the Auto-Submit+1 label when
	// uploading the change. This should only be enabled for projects which
	// support Auto-Submit.
	SetAutosubmit bool `protobuf:"varint,3,opt,name=set_autosubmit,json=setAutosubmit,proto3" json:"set_autosubmit,omitempty"`
	// contains filtered or unexported fields
}

These control the behavior of the autoroller when it finds a non-trivial roll (i.e. a roll with expectation changes but which otherwise completes the simulation tests).

func (*AutorollRecipeOptions_NontrivialOptions) Descriptor deprecated 

func (*AutorollRecipeOptions_NontrivialOptions) Descriptor() ([]byte, []int)

Deprecated: Use AutorollRecipeOptions_NontrivialOptions.ProtoReflect.Descriptor instead.

func (*AutorollRecipeOptions_NontrivialOptions) GetAutomaticCommitDryRun 

func (x *AutorollRecipeOptions_NontrivialOptions) GetAutomaticCommitDryRun() bool

func (*AutorollRecipeOptions_NontrivialOptions) GetExtraReviewerEmails 

func (x *AutorollRecipeOptions_NontrivialOptions) GetExtraReviewerEmails() []string

func (*AutorollRecipeOptions_NontrivialOptions) GetSetAutosubmit 

func (x *AutorollRecipeOptions_NontrivialOptions) GetSetAutosubmit() bool

func (*AutorollRecipeOptions_NontrivialOptions) ProtoMessage 

func (*AutorollRecipeOptions_NontrivialOptions) ProtoMessage()

func (*AutorollRecipeOptions_NontrivialOptions) ProtoReflect 

func (x *AutorollRecipeOptions_NontrivialOptions) ProtoReflect() protoreflect.Message

func (*AutorollRecipeOptions_NontrivialOptions) Reset 

func (x *AutorollRecipeOptions_NontrivialOptions) Reset()

func (*AutorollRecipeOptions_NontrivialOptions) String 

func (x *AutorollRecipeOptions_NontrivialOptions) String() string

type AutorollRecipeOptions_TrivialOptions 

type AutorollRecipeOptions_TrivialOptions struct {

	// One of these email addresses will be randomly selected to be TBR'd.
	TbrEmails []string `protobuf:"bytes,1,rep,name=tbr_emails,json=tbrEmails,proto3" json:"tbr_emails,omitempty"`
	// If true, the autoroller recipe will automatically CQ the change.
	AutomaticCommit bool `protobuf:"varint,2,opt,name=automatic_commit,json=automaticCommit,proto3" json:"automatic_commit,omitempty"`
	// If true and automatic_commit is false, the autoroller recipe will
	// automatically do a CQ dry run when uploading the change.
	DryRun            bool                                                   `protobuf:"varint,3,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	SelfApproveMethod AutorollRecipeOptions_TrivialOptions_SelfApproveMethod `` /* 189-byte string literal not displayed */
	// contains filtered or unexported fields
}

These control the behavior of the autoroller when it finds a trivial roll (i.e. a roll without expectation changes).

func (*AutorollRecipeOptions_TrivialOptions) Descriptor deprecated 

func (*AutorollRecipeOptions_TrivialOptions) Descriptor() ([]byte, []int)

Deprecated: Use AutorollRecipeOptions_TrivialOptions.ProtoReflect.Descriptor instead.

func (*AutorollRecipeOptions_TrivialOptions) GetAutomaticCommit 

func (x *AutorollRecipeOptions_TrivialOptions) GetAutomaticCommit() bool

func (*AutorollRecipeOptions_TrivialOptions) GetDryRun 

func (x *AutorollRecipeOptions_TrivialOptions) GetDryRun() bool

func (*AutorollRecipeOptions_TrivialOptions) GetSelfApproveMethod 

func (x *AutorollRecipeOptions_TrivialOptions) GetSelfApproveMethod() AutorollRecipeOptions_TrivialOptions_SelfApproveMethod

func (*AutorollRecipeOptions_TrivialOptions) GetTbrEmails 

func (x *AutorollRecipeOptions_TrivialOptions) GetTbrEmails() []string

func (*AutorollRecipeOptions_TrivialOptions) ProtoMessage 

func (*AutorollRecipeOptions_TrivialOptions) ProtoMessage()

func (*AutorollRecipeOptions_TrivialOptions) ProtoReflect 

func (x *AutorollRecipeOptions_TrivialOptions) ProtoReflect() protoreflect.Message

func (*AutorollRecipeOptions_TrivialOptions) Reset 

func (x *AutorollRecipeOptions_TrivialOptions) Reset()

func (*AutorollRecipeOptions_TrivialOptions) String 

func (x *AutorollRecipeOptions_TrivialOptions) String() string

type AutorollRecipeOptions_TrivialOptions_SelfApproveMethod 

type AutorollRecipeOptions_TrivialOptions_SelfApproveMethod int32
const (
	// Will set Bot-Commit+1 label.
	AutorollRecipeOptions_TrivialOptions_BOT_COMMIT_APPROVE AutorollRecipeOptions_TrivialOptions_SelfApproveMethod = 0
	// Will set Code-Review+1 label.
	AutorollRecipeOptions_TrivialOptions_CODE_REVIEW_1_APPROVE AutorollRecipeOptions_TrivialOptions_SelfApproveMethod = 1
	// Will set Code-Review+2 label.
	AutorollRecipeOptions_TrivialOptions_CODE_REVIEW_2_APPROVE AutorollRecipeOptions_TrivialOptions_SelfApproveMethod = 2
	// Will not set any labels besides Commit-Queue.
	AutorollRecipeOptions_TrivialOptions_NO_LABELS_APPROVE AutorollRecipeOptions_TrivialOptions_SelfApproveMethod = 3
)

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Descriptor 

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Descriptor() protoreflect.EnumDescriptor

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Enum 

func (x AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Enum() *AutorollRecipeOptions_TrivialOptions_SelfApproveMethod

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) EnumDescriptor deprecated 

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use AutorollRecipeOptions_TrivialOptions_SelfApproveMethod.Descriptor instead.

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Number 

func (x AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Number() protoreflect.EnumNumber

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) String 

func (x AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) String() string

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Type 

func (AutorollRecipeOptions_TrivialOptions_SelfApproveMethod) Type() protoreflect.EnumType

type DepRepoSpecs 

type DepRepoSpecs struct {
	RepoSpecs map[string]*RepoSpec `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

Emitted by the `recipes.py dump_specs` command.

func (*DepRepoSpecs) Descriptor deprecated 

func (*DepRepoSpecs) Descriptor() ([]byte, []int)

Deprecated: Use DepRepoSpecs.ProtoReflect.Descriptor instead.

func (*DepRepoSpecs) GetRepoSpecs 

func (x *DepRepoSpecs) GetRepoSpecs() map[string]*RepoSpec

func (*DepRepoSpecs) ProtoMessage 

func (*DepRepoSpecs) ProtoMessage()

func (*DepRepoSpecs) ProtoReflect 

func (x *DepRepoSpecs) ProtoReflect() protoreflect.Message

func (*DepRepoSpecs) Reset 

func (x *DepRepoSpecs) Reset()

func (*DepRepoSpecs) String 

func (x *DepRepoSpecs) String() string

type DepSpec 

type DepSpec struct {

	// (required) The URL of where to fetch the repo. Must be a valid git URL.
	//
	// If you wish to avoid network/git operations, please use the `-O` override
	// functionality of recipes.py. See also `recipes.py bundle`.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// (required) The ref to git-fetch when syncing this dependency.
	//
	// This must be an absolute ref which the server at `url` recognizes (e.g.
	// 'refs/heads/...').
	//
	// DEPRECATED: Short refs (like 'main') will be implicitly converted to
	// 'refs/heads/...' with a warning.
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`
	// (required) The git commit that we depend on.
	Revision string `protobuf:"bytes,3,opt,name=revision,proto3" json:"revision,omitempty"`
	// contains filtered or unexported fields
}

func (*DepSpec) Descriptor deprecated 

func (*DepSpec) Descriptor() ([]byte, []int)

Deprecated: Use DepSpec.ProtoReflect.Descriptor instead.

func (*DepSpec) GetBranch 

func (x *DepSpec) GetBranch() string

func (*DepSpec) GetRevision 

func (x *DepSpec) GetRevision() string

func (*DepSpec) GetUrl 

func (x *DepSpec) GetUrl() string

func (*DepSpec) ProtoMessage 

func (*DepSpec) ProtoMessage()

func (*DepSpec) ProtoReflect 

func (x *DepSpec) ProtoReflect() protoreflect.Message

func (*DepSpec) Reset 

func (x *DepSpec) Reset()

func (*DepSpec) String 

func (x *DepSpec) String() string

type RepoSpec 

type RepoSpec struct {

	// The "API Version" of this proto. Should always equal 2, currently.
	ApiVersion int32 `protobuf:"varint,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"` // Version 2
	// The "repo name" of this recipe repository. This becomes
	// the prefix in DEPS when something depends on one of this repo's modules
	// (e.g.  DEPS=["recipe_engine/path"]).
	//
	// By convention, this should match the luci-config project_id for this repo,
	// but the only requirements are that:
	//   - It is unique within its recipes microcosm (i.e. no dependency tree of
	//     recipe repos can ever have two repos with the same name).
	//   - It must not contain slashes.
	//
	// One of 'repo_name' and 'project_id' (the old field) must be specified;
	// 'repo_name' takes precedence, and the autoroller will upgrade all
	// recipes.cfg files to have both. Eventually we will remove 'project_id'.
	RepoName string `protobuf:"bytes,7,opt,name=repo_name,json=repoName,proto3" json:"repo_name,omitempty"`
	// Deprecated: The old field for specifying repo_name.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// This is the URL which points to the 'source of truth' for this repo. It's
	// meant to be used for documentation generation.
	CanonicalRepoUrl string `protobuf:"bytes,3,opt,name=canonical_repo_url,json=canonicalRepoUrl,proto3" json:"canonical_repo_url,omitempty"`
	// The path (using forward slashes) to where the base of the recipes are found
	// in the repo (i.e. where the "recipes" and/or "recipe_modules" directories
	// live).
	RecipesPath string `protobuf:"bytes,4,opt,name=recipes_path,json=recipesPath,proto3" json:"recipes_path,omitempty"`
	// A mapping of a dependency ("repo_name") to spec needed to fetch its code.
	Deps map[string]*DepSpec `` /* 149-byte string literal not displayed */
	// The autoroller options for this repo. These options will be respected by
	// the autoroller recipe (which currently lives here:
	//
	//	https://chromium.googlesource.com/infra/infra/+/main/recipes/recipes/recipe_autoroller.py
	//
	// ).
	AutorollRecipeOptions *AutorollRecipeOptions `` /* 126-byte string literal not displayed */
	// If true, `recipes.py test train` will not generate the README.recipes.md
	// docs file, and `recipes.py test run` will not assert that the docs file is
	// up-to-date.
	NoDocs bool `protobuf:"varint,8,opt,name=no_docs,json=noDocs,proto3" json:"no_docs,omitempty"`
	// DEPRECATED; python3 is always required.
	RequirePy3Compatibility bool `` /* 133-byte string literal not displayed */
	// DEPRECATED; python3 is always used.
	Py3Only bool `protobuf:"varint,10,opt,name=py3_only,json=py3Only,proto3" json:"py3_only,omitempty"`
	// If true, this repo will not allow any tests to exit with a status code that
	// mismatches the expected status of the `test` kwarg of the test data (e.g.
	// `yield api.test("name", ..., status="FAILURE")`), which defaults to SUCCESS
	// if not specified.
	EnforceTestExpectedStatus bool `` /* 142-byte string literal not displayed */
	// This is a list of recipe warnings which will be treated as errors. The list
	// items must always be in the form of "repo_name/WARNING_NAME", e.g.
	// "recipe_engine/CQ_MODULE_DEPRECATED".
	//
	// If a warning in this list is emitted when running the tests (e.g.
	// `recipes.py test XXX`) it will be logged as an error and will cause the
	// test command to return 1 instead of 0.
	//
	// If a warning in this list doesn't exist (e.g. the warning was removed from
	// the upstream repo), it will be reported with `recipes.py test XXX` that it
	// can be safely removed from this list.
	ForbiddenWarnings []string `protobuf:"bytes,12,rep,name=forbidden_warnings,json=forbiddenWarnings,proto3" json:"forbidden_warnings,omitempty"`
	// contains filtered or unexported fields
}

func (*RepoSpec) Descriptor deprecated 

func (*RepoSpec) Descriptor() ([]byte, []int)

Deprecated: Use RepoSpec.ProtoReflect.Descriptor instead.

func (*RepoSpec) GetApiVersion 

func (x *RepoSpec) GetApiVersion() int32

func (*RepoSpec) GetAutorollRecipeOptions 

func (x *RepoSpec) GetAutorollRecipeOptions() *AutorollRecipeOptions

func (*RepoSpec) GetCanonicalRepoUrl 

func (x *RepoSpec) GetCanonicalRepoUrl() string

func (*RepoSpec) GetDeps 

func (x *RepoSpec) GetDeps() map[string]*DepSpec

func (*RepoSpec) GetEnforceTestExpectedStatus 

func (x *RepoSpec) GetEnforceTestExpectedStatus() bool

func (*RepoSpec) GetForbiddenWarnings 

func (x *RepoSpec) GetForbiddenWarnings() []string

func (*RepoSpec) GetNoDocs 

func (x *RepoSpec) GetNoDocs() bool

func (*RepoSpec) GetProjectId 

func (x *RepoSpec) GetProjectId() string

func (*RepoSpec) GetPy3Only 

func (x *RepoSpec) GetPy3Only() bool

func (*RepoSpec) GetRecipesPath 

func (x *RepoSpec) GetRecipesPath() string

func (*RepoSpec) GetRepoName 

func (x *RepoSpec) GetRepoName() string

func (*RepoSpec) GetRequirePy3Compatibility 

func (x *RepoSpec) GetRequirePy3Compatibility() bool

func (*RepoSpec) ProtoMessage 

func (*RepoSpec) ProtoMessage()

func (*RepoSpec) ProtoReflect 

func (x *RepoSpec) ProtoReflect() protoreflect.Message

func (*RepoSpec) Reset 

func (x *RepoSpec) Reset()

func (*RepoSpec) String 

func (x *RepoSpec) String() string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.