Work Items can be manually associated on the Build Request Form for each project build, or work items can be derived based on commit logs. Work Items are linked to are linked with project build (hence with project version) and then are tracked through deployments to various environments. There are few different options to link work items with project build. Recommended option to link work items with project build is to use them in commit message.
Work items are linked to project build only if they are found to be valid based on Project’s Issue Tracking project’s issue tracking configurations.
Associating Work Items Manually on a Build Request Form
FlexDeploy ITS Work Items are added to the Build Request using just their number.
Other Work Items are associated using their pattern such as GLORY- + their id. This looks the same as GitHub, GitLab, Jira, etcWork item number syntax to be used with FlexDeploy depends on underlying issue tracking integration. See Out-of-the-Box Issue Tracking System Configuration for details.
Link by Commit Messages
Work items are captured and linked to a project build from the source control change logs. The change logs are parsed based on either the Work Item Pattern provided in the project issue tracking configuration or with # prefix. You can define a single pattern or multiple patterns separated by comma.
Note that issue tracking configurations are inherited by sub-folder and projects, this is very easy to view and manage on project issue tracking page.
In the below pictures, GLORY- is the work item pattern setup for the project and if commit message contains GLORY-60 which matches pattern GLORY-, it will be considered as linked work item for build.
...
Recommended option is to specify work items in commit message is prefixing by #. For example, you can use #701 to indicate Work Item 701, or #GLROY-10 to indicate Work Item GLORY-10. When using # prefix, there is not need to setup any Work Item Pattern on issue tracking configurations.
...
Link by manual Entry at Project Build Time
If you didn’t remember to put the work item number in your commit, and you are building the project manually, you can enter work item numbers at build time.
Multiple Work Items can be added using a comma.
...
Just enter work item number as per appropriate syntax and press comma (,). It will show up like shown in image below.
...
Once a build is submitted, the build workflow execution will attach link the tickets work items entered in the above Related Tickets field to the request form. You can see the description and link to tickets work items in the build and deploy execution rows, and in the Work Items section by clicking the Execution Id link.
...
Associating Work Items to builds using commit messages in the Change Logs
Work Items are also associated to a build from the source control change logs during a build for each project. The change logs are parsed based on the Ticket Pattern provided in the Project configuration or Issue Tracking System setup page. You can define a single pattern or multiple patterns separated by comma.
In the below pictures, GLORY- is the pattern setup for the project.
To associate a work-item from the FlexDeploy ITS, use the pound/hash symbol like #701 to associate ticket 701.
...
For Issue Tracking Systems which doesn't support prefix or pattern, you can add your custom parsing rule to extract the ticket numbers from change logs. For this, you can define the pattern inside your implementation class (parseTicketNumberFromChangeLogs is the method which should handle any additional patterns needed by project) and do the parsing accordingly.
...
. In addition, if there were more work items found as per change logs, those are linked as well.
Link to Project Packages
If you don’t put work item numbers in your commit message and you are working with a package-based project, you can associate work items with packages that will live through its build and deployment lifecycle. Go to the project and package which you wish to link a work item. Edit the package.
Add one or more work item. The dropdown only shows previously linked work items. Type the entire work item key to enter a new one.
...
Save. Now, builds and deployments of this package will be linked to these work items.