| Table of Contents |
|---|
GitHub ITS Instances
A GitHub instance looks like this:
...
Fill in the Username with an account that has access to the repo.
Creating an OAuth Token for FlexDeploy ITS
| Excerpt | ||
|---|---|---|
| ||
Go to GitHub and login as the user you want to comment on GitHub Issues with. Generate a Personal Access Token in Github following this guide: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token 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:   |
Setting up folders and projects to use the GitHub ITS Instance
Then back in FlexDeploy, setup your folder ITS settings like this:
...
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 tickets with commits or by manually entering them on project builds or project packages.
Linking with commit messages
Setup your FlexDeploy Project with a ticket pattern. The pattern must be github repo name + “-” + issue number.
...
Following this pattern, make a commit message.
...
Push and Merge your change.
...
When you create a build, the issue numbers are pulled from your commits.
...
Linking by Manual Entry at Project Build Time
If you didn’t remember to put the issue number in your commit, and you are building the project manually, you can enter issue numbers at build time.
The issue number should be GitHub Repo Name-Issue Number
In this example, maven-project-3.
...
Linking issues to project packages
If you don’t put issue numbers in your commits, and you are working with a package-based project, and you want to associate issues with packages that will live through the build and deployment lifecycle, you can follow this pattern.
Go to the project and package which you wish to link a GitHub Issue.
Edit the package.
Add one or more Issues. The drop down only shows previously linked issues. Type the entire issue key to make a new one.
Save.
...
The issue number should be in the format GitHub Repo Name-Issue Number
Now builds and deploys of this package will be associated to that GitHub Issue.