Set up your SCM system

If your CI server is set up to work with a Source Control Management (SCM) system, such as Git or Subversion (SVN), ALM Octane can help you track committed changes. For details, see Track changes committed to your Source Control Management system.

This topic explains how to customize SCM-related functionality.

Enable linking to your repository viewer (Git or SVN only)

For each file displayed in the list of changed files, ALM Octane can provide links to the file view and diff view in your repository viewer. To enable this, configure templates for the HTTP links.

This functionality is provided for repository viewers whose HTTP link templates include the file path and the revision.

To configure templates for links to your repository viewer:

  1. In Settings , click Spaces and select the workspace that is set up to integrate with your CI server.

  2. Click the DevOps tab. On the left side of the pane, select SCM Repositories.

    This page lists any Git and SVN repositories that integrate with your CI servers.

    Note: A repository is only displayed in this list after a pipeline run includes commits to the repository.

  3. For each repository (each row in the grid) enter the following:

    File link template. A template for the HTTP link to the file view of a selected file.

    Diff link template. A template for the HTTP link to the diff view of a selected file version.

    The templates must include the placeholders {filePath} and {revision}. ALM Octane replaces these with the relevant file's path and revision when creating the links.

Back to top

Customize commit message patterns

Commit message patterns define the strings to include in commit messages to associate them with ALM Octane stories.

To modify the default commit message patterns, define new patterns using Java regular expressions:

  1. In Settings , click Spaces and select the workspace that is set up to integrate with your CI server.

  2. Click the DevOps tab. On the left side of the pane, select Commit Patterns.

  3. Define the Commit message patterns to use for associating commits to the ALM Octane story types (User story, Quality story, Defect).

    Change an existing Commit message pattern or click + to add a new pattern. Using Java regular expressions, design a pattern that contains a single capturing group containing the story ID.

    For example, the default pattern defect\s*#(\d+) represents the string defect<any number of spaces>#<defect id>.

    The patterns are not case sensitive.

  4. Click Validate commit pattern in the toolbar, to experiment with your patterns and make sure that they match the string that you had in mind.

    In the Validate Commit Pattern dialog box, enter an experimental commit message or part of a message. Click Validate to see the stories that your commit patterns associate with this comment.

    Repeat this step to test all of the patterns you defined.

    Example: This commit message includes the string user story #4. Therefore, it matches the pattern for user stories:

  5. Make sure to tell your SCM users about the patterns their commit messages must follow.

Back to top

See also: