recipe_modules/gerrit_comment/options.proto

// Copyright 2022 The Pigweed Authors
//
// 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
//
//     https://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.

syntax = "proto3";

package recipe_modules.pigweed.gerrit_comment;

// When to post Gerrit comments on a change?
enum CommentBehavior {
  // Don't post comments if no behavior is explicitly requested.
  COMMENT_UNSPECIFIED = 0;
  // Only post the comment if the builder failed.
  COMMENT_ON_FAILURE = 1;
  // Post a comment when the builder completes, regardless of status.
  COMMENT_ALWAYS = 2;
}

message Options {
  CommentBehavior comment_behavior = 1;

  // Only post comments to CLs on these explicitly allowed Gerrit hosts. If this
  // is empty, no comments will be posted!
  //
  // This is intended to prevent potentially sensitive builder names from
  // leaking to comments on open-source projects.
  //
  // Example host: "pigweed-review.googlesource.com".
  repeated string allowed_gerrit_hosts = 2;
}