Versions Compared

Old Version 2

changes.mady.by.user Jaramy Conners

Saved on

compared with

New Version Current

changes.mady.by.user Jaramy Conners

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Getting Started with GitLab

Anchor
link
link
Linking

...

Strategic Roadmaps to your GitLab Instance

...

In order to connect your Roadmaps to your instances & projects in GitLab, an Account Admin on your Roadmunk Strategic Roadmaps account will need to establish the connection between Roadmunk Strategic Roadmaps and GitLab first. Once this connection is established, users will be able to view and select this integration option during their on-roadmap setup and save both instance & credential details for future setup of additional roadmaps.

Expand
titleCreate a New GitLab Integration

To create a new GitLab integration in RoadmunkStrategic Roadmaps:

  1. Click into your avatar in the bottom-left and navigate into the Account Settings menu.

  2. Once in Account Settings, navigate to the Integrations tab along the top.

  3. Select the + Add an integration button and choose GitLab from the configuration menu.

  4. In the setup window that appears, enter the following details:

    • GitLab Integration Name: The reference name which describes to yourself and your team the GitLab instance you're connecting to.

    • GitLab Integration URL is shown but cannot be edited due to the static nature of this pathway. Unlike other Roadmunk Strategic Roadmaps integrations, the instance being accessed is defined at the roadmap level, not the account level.

  5. Once these details have been entered, click the Create Integration button to finalize the setup.

Expand
titleUpdate an Existing GitLab Integration

To update an existing GitLab integration in RoadmunkStrategic Roadmaps:

  1. Click into your avatar in the bottom-left and navigate into the Account Settings menu.

  2. Once in Account Settings, navigate to the Integrations tab along the top.

  3. Select the Edit button in the GitLab Integration you're looking to update.

  4. In the edit window that appears, the administrator who created the integration can update:

    • GitLab Integration Name: The reference name which describes to yourself and your team the GitLab instance you're connecting to.

  5. Once these details have been changed, click the Update Integration button to finalize the setup. Changes are applied immediately for all users across the account.

Expand
titleRemove an Existing GitLab Integration

To delete an existing GitLab integration in RoadmunkStrategic Roadmaps:

  1. Prior to deletion, ensure that no roadmaps are currently using this particular integration.

  2. Click into your avatar in the bottom-left and navigate into the Account Settings menu.

  3. Once in Account Settings, navigate to the Integrations tab along the top.

  4. Select the Delete button in the GitLab integration you're looking to remove.

  5. Once selected, the integration will be deleted immediately and will be removed from the menu.

Anchor
credentials
credentials
Generating Credentials for

...

Strategic Roadmaps in GitLab

In order to authorize the data transfer between Roadmunk Strategic Roadmaps and GitLab, Roadmunk Strategic Roadmaps relies on a user-generated credential which allows the user to view and pull their data from their projects. In this case, we require a Personal Access Token (PAT) generated in GitLab as your credential and during the roadmap setup will allow you to set a Credential Label so you can easily differentiate this particular token from others you may use (in the case of teams working across multiple active GitLab deployments).

...

  • In GitLab, click on your public avatar and select Preferences > Access Tokens.

  • Specify a Token name. It can be anything and does not need to match the Credentials Label in RoadmunkStrategic Roadmaps.

  • At a minimum select read_api from the Select scopes section and update the Expiration date.

  • Click the Create personal access token button.

  • Click copy personal access token button and paste the value into the Personal Access Token field in RoadmunkStrategic Roadmaps.

Once they've expired (or as needed prior to expiration), tokens can be revoked, removed, or regenerated from the Personal Access Tokens menu. 

...

It's a quick and easy process to set up an integration between your GitLab projects and your team's roadmaps in RoadmunkStrategic Roadmaps. The setup process can be broken down into three stages: triggering the integration, applying synchronization settings, and applying field and filter settings. Once those have been completed, your roadmap will be set to pull and visualize data from GitLab as needed.

...

  • All fields pulled from GitLab are Account-Level by default - Since the properties and values of these synchronized fields are managed in GitLab, we automatically promote them to account-level so they can be accessible as common fields in Portfolio roadmaps.

  • There is an External ID field that appears in the Items Table view - When synchronizing data from GitLab, we pull in the ID of each issue for reference on your roadmap. This is clickable and linked out to your team's GitLab instance, so you can quickly access the respective work item from either your Table view and Item Card.

  • Unable to change or add new projects on a single roadmap - As with our other integrations, we limit connections between roadmaps and third-party tools to be a 1:1 connection. This means that you will be unable to sync multiple projects into a single roadmap; however, you will be able to create multiple roadmaps for each project and use those as sources in a Portfolio roadmap.

  • Additional Date fields will be read-only - Due to a variance in field formatting between Roadmunk Strategic Roadmaps and GitLab, any additional Date fields selected which are not mapped to Start and End Dates will be pulled in as read-only text fields.

  • Tokens may expire a set number of days after being created - Unlike API tokens generated for credentials in Jira, which have a longer-term expiry, Personal Access Tokens generated in GitLab will expire depending on your specifications during the setup. These tokens can be easily regenerated for continued use, but your in-app credentials will need to be updated.

...