DocumentaciónHelp

Connect GitHub or GitLab

Link branches, commits and pull or merge requests to the items in your agile desks, and move the item's status when the PR is opened or merged.

On this page

With this integration, every branch, commit and pull request (GitHub) or merge request (GitLab) that mentions an item's key, for example APP-123, is linked to that item in your agile desk. Optionally, the item moves forward on its own when the PR or MR is opened and when it is merged.

The GitHub and GitLab cards have the Proposed tag: the design of this integration may still change.

Before you start

  • In Elion ITSM you need Administer in the Settings module (for example, the Administrator role).

  • In GitHub or GitLab you need permission to create webhooks in the repository or project.

  • You can create one connection per repository, or a single one and use its URL in several repositories.

Step 1: connect in Elion ITSM

  1. Go to Settings → Integrations.

  2. In the GitHub or GitLab card, click Connect.

  3. Fill in:

    • Name: for example, the repository name.

    • Agile desks to search for items (none checked = all): check the desks whose items can be mentioned.

    • Optional rules (they only move the item forward):

      • When the PR is opened, move to (status) (in GitLab, When the MR is opened, move to (status)): it comes as review.

      • On merge, move to (status): it comes as qa.

      Enter the status key in lowercase, as it appears in the desk's settings. Leave it empty to not move the item.

  4. Click Connect.

A window opens that is shown only once, with the Webhook URL and the Webhook secret (in GitLab, Secret token). Use Copy URL and Copy secret. Do not close it until you finish step 2.

Step 2: create the webhook in the repository

On GitHub

  1. In the repository, go to Settings → Webhooks → Add webhook.

  2. In Payload URL, paste the URL. In Content type, choose application/json. In Secret, paste the secret.

  3. In the events, check Pushes and Pull requests.

  4. Save the webhook.

On GitLab

  1. In the project, go to Settings → Webhooks.

  2. In URL, paste the URL. In Secret token, paste the secret.

  3. Check Push events and Merge request events.

  4. Save the webhook.

Go back to Elion ITSM and click Done, I copied it.

What happens next

  • When you push or open a PR or MR that mentions APP-123 in the branch name, in a commit or in the title, the APP-123 item is linked.

  • If you defined rules, the item moves to the given status when the PR or MR is opened and when it is merged. The rules only move the item forward.

  • The connection shows Last contact with the date of the last event received.

Ask the team to name their branches with the item key, for example APP-123-login-con-google. It is the simplest way to keep everything linked.

Rotate the URL and the secret

If you think the URL or the secret leaked, click Rotate URL and secret and confirm with Rotate. The current ones stop working immediately: paste the new ones into the repository's webhook.

Related

Search Elion ITSM

Type at least 2 characters to search Elion ITSM.

↑↓ to navigate · Enter to open · Esc to close