Versions Compared

Version Old Version 14 New Version 15
Changes made by

Chandresh Patel

Karl Henselin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Creating an OAuth Token for FlexDeploy ITS

  1. Go to GitHub and login as the user you want to comment on GitHub Issues with.

  2. 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

  3. Choose an expiration date based on your security policies. Shorter expiration dates will require updating the ITS more frequently.

  4. Choose the following OAuth scopes to comment on and change status of issues:

GitHub ITS Instances

A GitHub instance looks like this:

Image RemovedImage Added

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, set up 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

Set up 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, 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, you can associate issues with packages that will live through its build and deployment lifecycle by following 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 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 Number

Now, builds and deployments of this package will be associated to that GitHub Issue.