recipes/static_checks.proto

// Copyright 2021 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 recipes.pigweed.static_checks;

message Readability {
  // Applicable file extensions.
  repeated string file_extensions = 1;

  // Label to vote on to indicate this CL is trivial with respect to the above
  // file extensions.
  string trivial_label = 2;

  // Number of lines below which the CL is assumed to be trivial.
  int32 line_number_threshold = 3;
}

message InputProperties {
  // Don't do anything that has external effects.
  bool dry_run = 1;

  // Email addresses of accounts allowed to bypass these restrictions.
  repeated string ignored_accounts = 2;

  // Require "Tested:" line.
  bool require_tested = 3;

  // List of extensions for documentation files. If present, CLs must modify at
  // least one file with one of these extensions.
  repeated string doc_patterns = 4;

  repeated Readability readability = 5;

  // Python regular expression that the commit message must match.
  string commit_message_regexp = 6;

  // Message to include in case regular expression fails to match (maybe with
  // a link to example commit messages).
  string commit_message_regexp_failure_message = 7;
}