Creating an OAuth Token for FlexDeploy ITS
Go to GitLab and login as the user you want to comment on GitLab Issues with.
Generate a Personal Access Token in GitLab following this guide: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
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:
GitLab ITS Instances
A GitLab instance looks like this:
Setting Up Folders and Projects to Use the GitLab ITS Instance
Then back in FlexDeploy, set up your folder ITS settings like this:
GitLab Issues only accept statuses of open and closed. Other statuses will be ignored.
Linking GitLab 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 GitLab 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 GitLab Repo Name-Issue Number
In this example, it’s asdf.
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 GitLab 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 GitLab Repo Name-Issue Number
Now, builds and deployments of this package will be associated to that GitLab Issue.