Skip to main content
Contact Support

Vendor URL templates for commit linking

Tags:

Flow automatically links to your commits—unless you have a self-hosted Git host. If you click View commit in any report and it redirects you to Flow instead of to your Git host, you'll know you need to set up a vendor URL template. This shows Flow how to link correctly to your commits. You only need to set up one template for each hostname.

Permissions

You need View and manage or View, manage, and delete Manage integrations permissions to set and edit commit links.

Learn more about permissions.

back to top

Creating a Vendor URL template

Once you’ve identified a commit or integration that requires a Vendor URL template, create one in the integration settings.

  1. Click Settings in the top navigation

  2. Click Integrations

  3. In the top right corner, click Vendor URLs

  4. Click Create template

  5. Add the hostname for the Git host you want to create a vendor URL template for

    Note: Because cloud vendors do not require vendor URL templates to link to commits, you cannot insert a hostname for github.com, gitlab.com or bitbucket.com. If you do, you’ll be unable to save the template.

  6. Confirm that the Commit URL is in the correct form with the variables in the correct locations.

  7. If you need to update the Commit URL:

    1. Click the X button next to any variables you want to remove

    2. Type in any additional content as needed

    3. To add a variable back, place your cursor where you want the variable located, then click the variable chip below to insert it

  8. Once you’ve confirmed the Commit URL structure, select an integration to find the latest commit from the integration to test

    1. Once you’ve selected an integration, click Verify Commit URL

    2. If a commit is found, click on it to make sure it correctly links to your Git host. If not, make any required changes to the hostname and Commit URL, then repeat this process to test again

  9. Click Create to create your template

Note: Verifying and testing Commit URLs is not required to create a Vendor URL template, but it is highly recommended to ensure your template is successful. The integration dropdown may not match the Integrations affected column exactly since that column is auto-generated based on all integrations where the hostname of the template is included in the integration’s URL.

Once you’ve completed template creation, return to the commit in Flow reports, and click View commit again to ensure the linking was successful.

back to top

Creating a Vendor URL template in Daily update

To create a Vendor URL template in Daily update:

  1. Click Reports in Flow’s top navigation bar.
  2. In the left navigation under Daily check, click Daily update.
  3. Click a commit from Commits with the Biggest Impact or Commits from yesterday.
  4. If the commit is linked correctly, Flow directs you to your commit in your Git host.
    • If Flow can't link to your commits, a warning modal appears:
  5. Locate an individual commit from the same repo in your Git host. Copy and paste your commit URL into the modal. The URL follows this format: https://{host}/{repo}/commits/{sha}
  6. Click Yes, it did! after successfully making a URL template. This saves these settings for this repo so you can easily access your commits directly from Flow.

back to top

Viewing and editing Vendor URL templates

Once you’ve created Vendor URL templates, view and edit them on the Vendor URL templates page. To access this page:

  1. Click Settings in the top navigation

  2. Click Integrations

  3. In the top right corner, click Vendor URLs

On this page:

  1. The Hostname column provides the name of the host for your commit. The hostname is used to populate the Host variable in the URL template.

  2. The Commit URL column shows the URL template linking to the commit.

  3. The Integrations affected column shows the integrations that use the host name. Each of these integrations use this template to link to their commits.

  4. The Last updated column shows the date the URL was last updated.

  5. The Edit column allows you to edit the URLs.

Note: The Integrations affected column may not match the integration you selected to test with while creating the template.

To edit an existing Vendor URL template:

  1. Click the three dots icon next to the URL you want to edit

  2. Click Edit template

  3. You will see a pop up modal where you can edit the URL

    • Use the Hostname field to edit the hostname of your commit. The hostname field is pre-populated based on the hostname provided to Flow

    • Use the Commit URL field to edit the commit URL. When you click inside the field, you will see URL template variables. Click the variable you want to edit

    • The Variables and their meanings section provides the variable names for the URL and their definition. Click a variable name to populate that variable field in the Commit URL template field

    • Select an integration to create a commit link so you can test and verify your changes. Make sure you are able to access your commit using the link.

When you’ve finished making your changes, click Update.

To delete an existing Vendor URL template, click the three dots icon, then click Remove template. Confirm the removal to finish.

Related articles