recipe_modules/run_script_roll/run_script_entry.proto

// Copyright 2026 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.run_script_roll;

message RunScriptEntry {
  // Path to the script within the checkout. Required.
  // This script should take no arguments, but can read from the environment.
  // It must output a JSON dict to stdout containing the following:
  // * name: The name of the roll.
  // * header: A one-line description of the roll.
  // * body: A multi-line description of the roll.
  // * properties: A dictionary of output properties to set on the build.
  //
  // If there are multiple rolls in the change, the commit message will look
  // like this:
  //
  //    roll: {stdout.name}, other_roll
  //
  //    {stdout.name}: {stdout.header}
  //    {stdout.body}
  //
  //    other_roll header
  //    other_roll body
  //
  // If there is only one roll in the change, the commit message will look
  // like this:
  //
  //    roll: {stdout.name} {stdout.header}
  //
  //    {stdout.body}
  string script = 1;
}