SourceCodeRepositoryBranch

Represents a specific branch within a source control repository, such as a feature branch for a work item or a release branch for a pipeline stage. Work Item and Pipeline Stage records refer to this object.

Introduced in API version 64.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Serialized JSON representation of the preprocessed contents of the .forceignore file on the branch.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the branch as it exists in the source control provider. For example, feature/WI-000001.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unique identifier of the parent branch from which this branch was originally created. In GitHub, this ID is called a SHA. DevOps Center uses this ID to recreate the branch if necessary.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unique identifier representing the latest synced state of this branch in the source control provider. In GitHub, this ID is called the HEAD SHA.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date and time when the branch identified by Remote Reference field was last updated or synced.

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The ID of the parent SourceCodeRepository record in which the branch lives.

    This field is a relationship field.

  • Relationship name: SourceCodeRepository

  • Relationship type: masterdetail

  • Refers to: SourceCodeRepository

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Indicates the current health or sync state of the branch.
  • Possible values:
    • DEPLOYMENT_ERROR — DEPLOYMENT_ERROR — A deployment to the environment associated with this branch failed.
    • MERGE_CONFLICT — MERGE_CONFLICT — A conflict exists between this branch and its target promotion branch.

Use this object to track the state of the feature branch every time a developer starts a new work item. Similarly, each stage in a pipeline is mapped to a specific branch defined in this object. It stores remote references (commit SHAs) and tracks sync issues like merge conflicts.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.