1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. SourceContextRequest

SourceContextRequest

    Request to configure a source context: git-based, Mercurial-based, or template-based. Only one may be specified.

    Properties

    • Git-based source context configuration.
    • repoUrl string optional
      The URL of the git repository.
    • branch string optional
      The branch to use from the repository.
    • repoDir string optional
      The subdirectory within the repository where Pulumi.yaml is located.
    • commit string optional
      The commit hash to deploy. Mutually exclusive with branch.
    • gitAuth GitAuthConfigRequest optional
      Git authentication configuration.
    • Mercurial-based source context configuration.
    • repoUrl string optional
      The URL of the Mercurial repository.
    • branch string optional
      The branch to use from the repository.
    • repoDir string optional
      The subdirectory within the repository where Pulumi.yaml is located.
    • revision string optional
      The changeset hash to check out.
    • hgAuth GitAuthConfigRequest optional
      Mercurial authentication configuration.
    • Template-based source context configuration.
    • sourceUrl string optional

      The URL of the template source. Supports two URL schemes:

      Registry-backed templates use the registry:// scheme with the format: registry://templates/source/publisher/name[@version]

      • source: The template source identifier (e.g., the registry source name)
      • publisher: The organization or user that published the template
      • name: The template name
      • version: Optional semver version (e.g., 1.0.0). If omitted, defaults to the latest version

      Example: registry://templates/pulumi/acme-corp/aws-vpc@2.1.0

      VCS-backed templates use standard VCS URLs (GitHub, GitLab, Azure DevOps, etc.): https://github.com/org/repo

    • gitAuth GitAuthConfigRequest optional
      Git authentication configuration for accessing the template source.