...
Getting Started with GitHub
| Anchor | ||||
|---|---|---|---|---|
|
...
Strategic Roadmaps to your GitHub Instance
...
In order to connect your Roadmaps to your instances & repos in GitHub, an Account Admin on your Roadmunk Strategic Roadmaps account will need to establish the connection between Roadmunk Strategic Roadmaps and GitHub 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 | ||
|---|---|---|
| ||
To create a new GitHub integration in RoadmunkStrategic Roadmaps:
|
| Expand | ||
|---|---|---|
| ||
To update an existing GitHub integration in RoadmunkStrategic Roadmaps:
|
| Expand | ||
|---|---|---|
| ||
To delete an existing GitHub integration in RoadmunkStrategic Roadmaps:
|
| Anchor | ||||
|---|---|---|---|---|
|
...
Strategic Roadmaps in GitHub
In order to authorize the data transfer between Roadmunk Strategic Roadmaps and GitHub and ensure that user permissions are respected, Roadmunk Strategic Roadmaps relies on a user-generated credential which allows the user to view and pull their data from their projects & boards. In this case, we require a Personal Access Token (PAT) generated in GitHub 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 GitHub deployments).
...
Users can generate a Personal Access Token from the Settings menu in GitHub and reference GitHub's article on creating a personal access token for more details. In order to create a token, users must first specify both the Token Expiration and Token Scope. The teams at Roadmunk Strategic Roadmaps and GitHub strongly recommend that you set an expiration date for your token to help keep your information secure. Once they've expired (or as needed prior to expiration), tokens can be revoked, removed, or regenerated from the Personal Access Tokens menu. When choosing the Token Scope, Roadmunk Strategic Roadmaps requires that you select the repo option from the provided menu - this allows Roadmunk Strategic Roadmaps to properly access and view all repos and their associated content.
Permissions Limitations between
...
Strategic Roadmaps & GitHub
Please note that Roadmunk Strategic Roadmaps will respect the permissions of your GitHub account tied to the user-provided credentials mentioned above and will limit content visibility during the sync setup to match that of GitHub. This means that if your provided credentials only allow you to view certain content, then these limitations will carry over into RoadmunkStrategic Roadmaps.
If you do find that you are unable to access or view certain repos, projects or issues are not populating, please connect with your GitHub administrator to ensure that you have the appropriate permissions to view and access that particular content.
...
It's a quick and easy process to set up an integration between your GitHub repos 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 GitHub as needed.
...
All fields pulled from GitHub are Account-Level by default - Since the properties and values of these synchronized fields are managed in GitHub, 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 GitHub, we pull in the ID of each issue for reference on your roadmap. This is clickable and linked out to your team's GitHub 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 GitHub, 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 GitHub 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.
...