recipes/sdk.proto

// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

syntax = "proto3";

package recipes.fuchsia.sdk;

import "recipe_modules/fuchsia/fxt/options.proto";
import "recipe_modules/fuchsia/presubmit_util/options.proto";

// Sdk fully describes how to execute an SDK task.
message InputProperties {
  // Remote manifest project to checkout.
  string project = 1;

  // Manifest to checkout.
  string manifest = 2;

  // The remote integration manifest repository.
  string remote = 3;

  // GCS bucket to upload the SDK to.
  string gcs_bucket = 4;

  // Name to assign to the base SDK, e.g. "core".
  string sdk_name = 5;

  // CIPD package root to upload the SDK to.
  string cipd_root = 6;

  // Whether to skip creating the GN SDK.
  // TODO(crbug.com/1432399): Delete once we delete the GN SDK.
  bool skip_gn_sdk = 7;

  // Images to accompany the SDK.
  repeated CompanionImage companion_images = 8;

  message CompanionImage {
    // Name of the image when referred to in the SDK.
    string name = 1;

    // Name of the builder generating the image.
    string builder = 2;
  }

  // If true, overwrite the SDK version to match the input release version.
  bool is_release_version = 9;

  // Branch and ref settings for the SDK.
  repeated RefSetting ref_settings = 10;

  message RefSetting {
    // Update refs and stamps if input release version is reachable on this
    // branch.
    string branch = 1;

    // Update this CIPD ref and GCS stamp.
    string update_ref = 2;
  }

  // Presubmit options for testing in external infrastructures.
  recipe_modules.fuchsia.presubmit_util.Options external_testing = 11;

  message FuchsiaToolOverrides {
    // The name of the tool as it appears in tool_paths.json in the fuchsia
    // build.
    string tool_name = 1;

    // The name of the CIPD package that the tool should override.
    string cipd_pkg_name = 2;
  }

  message SDKOverrideConfigs {
    // Whether to use package_overrides.json to override the SDK.
    bool use_package_overrides = 1;

    // Whether to use gclient variables to override the SDK.
    bool use_gclient_variables = 2;

    // Filepath to override the SDK GCS path.
    string override_config_file = 3;

    // The tools from the fuchsia build to add to the package overrides.
    repeated FuchsiaToolOverrides tool_overrides = 4;
  }

  // Configurations for overriding the SDK in external infrastructures.
  SDKOverrideConfigs sdk_override_configs = 12;

  // Path to a fint parameters file within the fuchsia checkout.
  // TODO(crbug.com/1432399): Delete once we delete the GN SDK and no longer
  // need GN to locate Python in the checkout.
  string fint_params_path = 13;

  // External testing options.
  recipe_modules.fuchsia.fxt.Options fxt_options = 14;

  // Whether to relocate image archives.
  // TODO(fxbug.dev/127210): Delete after archives are no longer necessary to
  // build and distribute.
  bool relocate_image_archives = 15;

  // Whether to allow running against CLs in repos that aren't included in the
  // checkout. This is useful for builders that trigger companion image builders
  // that use different checkouts.
  bool allow_skipping_patch = 16;
}