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

SourceContext

    SourceContext describes some source code, and how to obtain it.

    Properties

    • git SourceContextGit optional
      Git-based source context for obtaining source code from a repository.
    • ↳ repoUrl string optional
      The URL of the git repository.
    • ↳ branch string optional
      The branch to use from the repository.
    • ↳ repoDir string optional
      (optional) RepoDir is the directory to work from in the project’s source repository where Pulumi.yaml is located. It is used in case Pulumi.yaml is not in the project source root.
    • ↳ commit string optional
      (optional) Commit is the hash of the commit to deploy. If used, HEAD will be in detached mode. This is mutually exclusive with the Branch setting. Either value needs to be specified.
    • ↳ gitAuth GitAuthConfig optional

      (optional) GitAuth allows configuring git authentication options There are 3 different authentication options:

      • SSH private key (and its optional password)
      • Personal access token
      • Basic auth username and password Only one authentication mode will be considered if more than one option is specified, with ssh private key/password preferred first, then personal access token, and finally basic auth credentials.
    • hg SourceContextHg optional
      Mercurial-based source context for obtaining source code from a repository.
    • ↳ repoUrl string optional
      The URL of the Mercurial repository.
    • ↳ branch string optional
      The branch to use from the repository.
    • ↳ repoDir string optional
      (optional) RepoDir is the directory to work from in the project’s source repository where Pulumi.yaml is located. It is used in case Pulumi.yaml is not in the project source root.
    • ↳ revision string optional
      (optional) Revision is the changeset hash to check out. If used, the working directory will be updated to this specific revision. This is mutually exclusive with the Branch setting. Either value needs to be specified.
    • ↳ hgAuth GitAuthConfig optional

      (optional) HgAuth allows configuring Mercurial authentication options. There are 3 different authentication options:

      • SSH private key (and its optional password)
      • Personal access token
      • Basic auth username and password Only one authentication mode will be considered if more than one option is specified, with ssh private key/password preferred first, then personal access token, and finally basic auth credentials.
    • template SourceContextTemplate optional
      Template-based source context for obtaining source code from a template URL.
    • ↳ 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 GitAuthConfig optional
      GitAuth allows configuring git authentication options The only authentication option is personal access token as of now.