Skip to content

librarian: redefine pipeline-config file #773

@codyoss

Description

@codyoss

Reference: go/librarian:cli-reimagined

We are removing the file altogether for now from the standpoint of a language repo. We will still support a version of this file for passing in secretes in CI. This file will be called env-config.yaml. It will have the following schema:

# A project to source any secrets from.
secret_project: "my-project"
# Specific configuration for each individual command.
commandEnvironmentVariables:
  # Common values are passed to all container commands
  common:
  - name: SOURCELINK_REPO
    default: https://github.com/googleapis/google-cloud-dotnet
  # Config for the 'generate' container command, but can be any command
  generate:
    # The environment variables to populate for this command.
    environment_variables:
      - # The name of the environment variable (e.g. TEST_PROJECT).
        name: "GENERATOR_FLAGS"
        # The default value to specify if no other source is found for the environment
        # variable. If this is not provided and no other source is found, the environment
        # variable will not be passed to the container at all.
        default_value: "--clean --new-clients"
      - name: "API_KEY"
        # The name of the secret to be used to fetch the value of the environment
        # variable when it's not present in the host system. If this is not specified,
        # or if a Secret Manager project has not been provided to Librarian,
        # Secret Manager will not be used as a source for the environment variable.
        secret_name: "generator-api-key" # Fetched from Secret Manager
        default_value: "" # No default, will be empty if secret not found

As a part of this change we should remove the proto definitions and stubs. Let's add markdown docs describing this schema in the doc folder.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions