GitHub Issues Integration
- Karl Henselin
- Chandresh Patel
Syntax for GitHub Issues
GitHub issues are represented as RepoName-NUMBER in FlexDeploy. For example, demo-1, demo-2 where demo is name of GitHub project. See image below for reference.
FlexDeploy will accept and show GitHub issues as demo-1, demo-2 etc.
Preparing for GitHub Issues with FlexDeploy
You need to create an OAuth Token for use in FlexDeploy. This token will be entered for GitHub Personal Access Token on Issue Tracking Instance.
Go to GitHub and log in as the user you want to comment on GitHub Issues with.
Generate a Personal Access Token in GitHub following this guide: Managing your personal access tokens - GitHub Docs
Choose an expiration date based on your security policies. Shorter expiration dates will require updating the ITS more frequently.
Choose the following OAuth scopes to comment on and change status of issues:
Create Issue Tracking Instance
A GitHub instance looks like this:
Property Name | Property Code | Required | Description |
|---|---|---|---|
GitHub Base URL |
| Yes | GitHub base URL (https://github.com/%7Bowner%7D) GitHub Base URL is based on GitHub username or organization. |
GitHub Username |
| Yes | Username should be an account that has access to the repository where issues are managed. |
GitHub Personal Access Token |
| Yes | Use Personal Access Token for the username. |
GitHub Base API Path |
| Yes | GitHub base API path (https://api.github.com or https://hostname/api/v3 for GitHub Enterprise) |
Configure Folder or Project for Issue Tracking
Configure GitHub Issue Tracking Instance on your project or parent folder. Issue Tracking configurations are inherited by sub-folder and projects. This configuration will allow you to integrate GitHub issues with your builds. See Configure Project for Issue Tracking for more details.
Work Item pattern is optional, if specified his will used to parse commit logs work item numbers. Alternatively, you can just prefix work item numbers with # in commit message.
Optionally configure for Comment and/or Status update after build or deploy execution.
GitHub Issues only accept statuses of open and closed. Other statuses will be ignored.
Linking GitHub Issues to FlexDeploy Builds
Now you are ready to link GitHub issues with project builds. In order to link
using commit messages - use the format #issue for example, #demo-1. Or you use demo-1234 in commit message if demo- is setup as work item pattern.
manually at build time - just specify work item number(s) on build request form in work items input. Note that # prefix only necessary with commit message.
manually with package - just specify work item number(s) on package configuration.
See Associate Work Items to a Build for more information about linking Work Items to builds.
Examples
Â
- style