Interface Commit

Commit

Represents a commit in the version control system.

interface Commit {
    author: Author;
    authorTimestamp: string;
    displayId: string;
    fileCount: number;
    files?: File[];
    flags?: "MERGE_COMMIT"[];
    hash?: string;
    id: string;
    issueKeys: string[];
    message: string;
    updateSequenceId: number;
    url: string;
}

Hierarchy

  • Record<string, unknown>
    • Commit

Properties

author authorTimestamp displayId fileCount files? flags? hash? id issueKeys message updateSequenceId url

Properties

author

author: Author

Author

Describes the author of a particular entity

authorTimestamp

authorTimestamp: string

The author timestamp of this commit. Formatted as a UTC ISO 8601 date time format.

Example

2016-10-31T23:27:25+00:00

displayId

displayId: string

Shortened identifier for this commit, used for display. Max length is 255 characters.

Example

a7727ee

fileCount

fileCount: number

The total number of files added, removed, or modified by this commit

Example

1

Optionalfiles

files?: File[]

List of file changes. Max number of files is 10. Currently, only the first 5 files are shown (sorted by path) in the UI. This UI behavior may change without notice.

Optionalflags

flags?: "MERGE_COMMIT"[]

The set of flags for this commit

Example

[MERGE_COMMIT]

Optionalhash

hash?: string

Deprecated. Use the id field instead.

Deprecated

id

id: string

The identifier or hash of the commit. Will be used for cross entity linking. Must be unique for all commits within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters

Example

a7727ee6350c33cdf90826dc21abaa26a5704370

issueKeys

issueKeys: string[]

List of issues keys that this entity is associated with. They must be valid Jira issue keys.

Example

[
  "ISSUE-1",
  "TEST-2"
]

message

message: string

The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down to 1024 characters.

Example

README.md edited online with Bitbucket

updateSequenceId

updateSequenceId: number

An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.

Example

1523494301248

url

url: string

The URL of this commit. Max length is 2000 characters.

Example

https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370

Settings

Member Visibility

On This Page

Properties