Commit detail

The Commit Detail shows information pertaining to a single version control commit including attributes like the repository commit ID, full commit message, commit author, date and time of commit, etc. This view also shows the relationship of the commit to other activities like builds, reviews, and work items.

Commit Defined for TeamForge EventQ

Since EventQ gathers information from disparate sources, we must define the conditions under which EventQ categorizes SCM actions as "commits". Usage of the term "commit" should be construed generically rather than in the context of a specific brand of SCM. For instance, SCMs like Subversion and CVS have a relatively straightforward definition of commit, typically meaning the sending of code changes from working copy to the repository. Git and dynamic version control systems (DVCS) have more nuanced definitions. To be considered a commit in TeamForge EventQ a DVCS action must be public. Therefore, a TeamForge EventQ commit encompasses both a Subversion commit and a Git "push", but doesn't include a Git "commit" (which is local).

Commit Detail Attributes

The step associated with the current activity is highlighted. To see the detail for a different activity, click on the associated step.

The Commit Detail displays these SCM commit attributes:
Commit Detail Attribute Description Location
SCM repository commit ID The ID marker denoting a particular revision or version of the SCM repository. For Git, this is the full hash. Commit activity header
SCM source display name The user defined "friendly" label for an SCM source repository. Commit activity header
Committer Name and user profile picture of the user responsible for the commit transaction. A default user avatar is depicted if the user has not defined a profile picture in TeamForge. Commit summary
Commit message The committer's explanatory text submitted at commit time. Commit summary
Committed At The date and time of the commit. Commit summary
Comment Comment and user profile picture of the user who created the comment. A default user avatar is depicted if the user has not defined a profile picture in TeamForge. Comment section
Note: See Integrating with TeamForge EventQ for a list of supported build, SCM, and review sources.

Commit Associations

Commits may be associated with other project activities such as builds, reviews, work items. Such commit associations are created by TeamForge EventQ in either of these ways:
  • Implicitly — For example, when a commit is associated to an automated build or is referenced by a code review.
  • Explicitly — For example, by referencing a formatted external ID in the commit message.
The Commit Detail displays this information in the "Associations" section:
  • Reviews — Reviews that are associated with this commit are identified by their source display name and review ID. Reviews are linked to the corresponding Review Detail page. Commits are associated with a particular review by commit message reference (explicit) or by inclusion in a post-commit type review (implicit). See Review detail for information about the review detail.
  • Builds — Builds are identified by the source display name and build ID, and are linked to the related Build Detail pages. See Build detail for information about the build details. Builds are automatically associated with the commits as reported by the build source (implicit).
    Note: The Commit Detail shows builds associated with that commit. If you do not see a particular build, ensure that the selected commit source in the build source configuration is correct.

  • Work Items — Work items can be directly associated to commits by referencing the work item artifact ID in the commit message. To explicitly link a commit with a work item, prepend to your commit message:

    [<artifact_id>]

    where the artifact_id is the ID of the work item in the originating source. You may specify more than one work item in your commit message.

Files and Operations

The "Files and Operations" section lists all files affected by the commit, and the operations performed on those files. Common SCM operations include add, delete, modify, and rename.