Last updated Apr 15, 2024

Create a template

Standardize your software creation workflow by creating templates that integrate best practices and adhere to your organization’s standards.

Templates are cataloged as components, include boilerplate code, and can include webhooks for automating the rest of your toolchain.

Learn more about templates

Before you begin

Install a supported source code management app

To take the following steps, you must be a Compass admin.

  1. In the main navigation, select Apps.

  2. Find the Bitbucket or GitHub app and select Install.

Once the app is installed, you need to configure the app so it can connect to your repositories.

Configure the Bitbucket app with a workspace

To take the following steps, you must be a admin of the Bitbucket Cloud workspace you want to connect to Compass.

  1. In the main navigation, select Apps.

  2. Find the Bitbucket app, select Configure, and allow the app to access your Atlassian account.

  3. Select Connect Bitbucket, and continue to Bitbucket's permissions page.

  4. The Authorize for workspace list displays the workspaces that you are an admin of. Select a workspace to connect with Compass.

  5. Select Grant Access.

Once you’re connected to a Bitbucket workspace, you’ll be taken back to the Bitbucket app in Compass.

Configure the GitHub app with an organization

  1. In the main navigation, select Apps.

  2. Find the GitHub app, select Configure, and allow the app to access your Atlassian account.

  3. Select Connect GitHub, and continue to GitHub’s permissions page.

  4. In GitHub, select the organization account you want to connect to.

Once you’re connected to a GitHub organization, you’ll be taken back to the GitHub app in Compass.

Have a template repository you want to fork

Components created from a template fork that template's repository. Make sure you have a base repository link to add to the template.

Create a template

Start creating a template from anywhere in Compass by pressing c t.

You can create a maximum of one template on a Free plan and 20 on a Standard plan.

  1. In the main navigation, select Templates.

  2. On the Templates page, select Create.

  3. Fill out the basic information for the template.

    • Name and describe the template, to help people generally understand how to use it.
    • Give the template an owner team, so people know who to contact if they need help using it.
    • Paste a repository link. Components created from the template will fork this repository for boilerplate code.
      • The repository you are forking from must be in your connected Bitbucket workspace(s) or GitHub organization(s), regardless of whether the repository is public or private.
  4. Select Next.

  5. Optionally paste a webhook link to send a JSON event when a component is created from the template.

    Compass will send an HTTP POST request to the webhook, sharing a JSON payload that describes the new component. This means you can continue automation or orchestration of a new software component in your development environment.

    To see what the event looks like, refer to the JSON event preview.

    You cannot add or edit a webhook after a template is created. We’re adding this functionality soon.

  6. Optionally add one or more parameters to the template. Learn more about parameters.

    Parameters are used in conjunction with the webhook, and all parameters and their values are sent in the webhook payload as shown in JSON event preview.

  7. Select Next. You'll be taken to the template's Review page.

  8. If you're happy with everything select Create.

Next steps

  1. Add more information to the template’s Overview page.

  2. Let your team know how they can use the template.

Troubleshooting

Check that you’re adding a valid Bitbucket or GitHub repository link from the workspace(s) or organization(s) connected to the respective app.

I created a template, but a webhook wasn't added to it

Sometimes this happens due to a network error. Delete the template and create a new one with the webhook you want to add.

I can't add parameters

There is currently a limit of 100 parameters per template. If you need more than 100 parameters please reach out as we'd love to chat with you!

Coming soon

We're working on improving templates with the following features:

  • GitLab support.

  • Edit templates after they’re created.

  • Validate webhooks as templates are created.

  • Additional parameter types, such as single select and multi-select.

  • Customize webhook events to call third-party APIs when components are created from templates (for example, create a new service in Opsgenie each time a component is created from a template).

Rate this page: