| Table of Contents |
|---|
GitHub ITS Instances
A GitHub instance looks like this:
...
Fill in the base url with the github username or org-based url. This url should be the one that your projects are sourced out of.
Fill in the Username with an account that has access to the repo.
Creating an OAuth Token for FlexDeploy ITS
...
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: 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:
...
...
GitHub ITS Instances
A GitHub instance looks like this:
...
Fill in the base URL with the GitHub username or org-based URL. This URL should be the one that your projects are sourced out of.
Fill in the Username with an account that has access to the repo.
Fill in the Personal Access Token using the value you created above.
The help text assists you with the Base API Path.
Setting Up Folders and Projects to Use the GitHub ITS Instance
Then back in FlexDeploy, setup set up your folder ITS settings like this:and project Issue Tracking settings.
...
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
Set up your FlexDeploy Project project or folder with a ticket pattern. The pattern must be github GitHub repo name + “-” + issue number.
...
Following this pattern, make a commit message.
...
Push and Merge merge your change.
...
When you create a build, the issue numbers are automatically 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 also enter issue numbers at build time.
The issue number should be GitHub Repo Name-Issue Number
In this example, it’s 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 can associate issues with packages that will live through the its 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 by clicking the edit package button on the right panel. The drop down dropdown 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 NumberNow . After saving, all builds and deploys deployments of this package will automatically be associated to that GitHub Issue.
...