Support and Documentation

Build information

The Build Information tool provides access to the build history for an application, showing commits and other information. You can configure external services, such as GitHub, Hudson, and JIRA, allowing you to reference bugs you have fixed and code you have changed.

When fixing a JIRA bug, add a reference to the bug code (such as ABC-123) to the commit message. This is then linked automatically in the Build Information tool. You can add multiple bug references to a single commit, and all will be linked individually.

Configuring build information

Add the following to a Maven project's pom.xml file to configure the build tool:

<issueManagement>
    <system>JIRA</system>
    <url>JIRA_URL_HERE</url>
</issueManagement>

<scm>
    <connection>scm:git:ssh://git@github.com/organization/repo-name.git</connection>
    <developerconnection>scm:git:ssh://git@github.com/organization/repo-name.git</developerconnection>
    <url>https://github.com/organization/repo-name</url>
</scm>

The above syntax specifies the SSH protocol. You can specify other protocols supported by Maven's implementation for source-control management. For examples, see SCM Implementation: Git

For example, the following <scm> element configures build information for the Brightspot repository.

<scm>
    <connection>scm:git:ssh://git@github.com/perfectsense/brightspot-cms.git</connection>
    <developerConnection>scm:git:ssh://git@github.com/perfectsense/brightspot-cms.git</developerConnection>
    <url>https://github.com/perfectsense/brightspot-cms</url>
</scm>
Viewing commit information
Procedure. To view commit information:
  1. Log in to github.

  2. In your web browser, navigate to http://brightspot-host/_debug/.

  3. Click Build Information.

  4. From the For list, select the build for which you want to review commits.

commit-information.png