Work items is FlexDeploy’s solution to issue tracking and much more where tasks, issues, stories, etc.. are abstracted into generalized “work items”. Work items can be created and managed natively in FlexDeploy. This feature is designed to help plan, track, and govern the tasks which are part of a release.
| Table of Contents |
|---|
...
At a high level work items provide traceability, context, and the ability to share progress and status of your tasks, issues, or stories. You can explore the child pages of this page to read about implementation of these work item systems.
The FlexDeploy issue tracking system can be used for creat and manage work items natively in FlexDeploy. Use work items to track progress for bugs, features, requirements etc.
| Table of Contents |
|---|
High Level Features
Create and manage work items.
Work item is created with title, type, description, assignee, tags etc.
Work item can be updated with comments, attachments, it can be assigned to a user and it’s status can be changed. Work item fields (if present) can be updated as well.
Work item type can be changed as necessary.
Work item detail will show linked build/deploy executions, work item update history. In addition you can view comments, attachments and source code commits associated with it.
Link FlexDeploy or External work items with build and track it’s progress.
External issue tracking systems like Jira, GitHub, GitLab, Azure Boards etc. can still be used in addition to FlexDeploy issue tracking system. All work items are visible on Work Items page.
Work item details will be mostly similar for FlexDeploy or External work items, but more modification options are available for FlexDeploy work items.
Custom Types, Statues and Fields are also available. Please see Work Item Administration page to understand customization options.
Work Item Created and Work Item Updated outgoing webhook events are available for FlexDeploy Work Items.
FlexDeploy work item related methods(get, create, update, update field etc.) are available in FLEXDEPLOY function, which allows for more integration capabilities from Webhook and Pipeline groovy scripts.
...
Creating a work item
Quickly create a new work item by clicking the plus icon on the navigational bar and selecting “Create Work Item”. Alternatively, create a work item from the work item screen which can be accessed from the menu or searched forsearching “Work-Item”.
...
The following popup will open where you can provide a name and type. There are also optional fields for a description, assignee, and tags. Assignee can be used to show ownership of the work item (i.e. whom will be completing the work for the work item) and tags provide a visual way to search for the work item. Once the work item is created it will display in the work items table.
...
...
Viewing / Edit a work item
You can view or edit any work item on the work-items screen. Additionally, from the a project execution, any previous execution which was linked to a work item contain a direct link to the work item aswell.
...
When viewing or editing a work item you will be provided with the work item number. The work item number (i.e. 4309 in the example below for the internal ITS system) is used to associate this work item with a build or deployment execution.
Work Item Core Details
Work item main details are shown below. You can adjust following details here.
Title
Assignee
Activity - Tags
Description
Status
Type
...
Activity Tab
Builds and deployments
...
are displayed on the Activity
...
tab. Work item updates such as status changes or uploaded attachments will display here
...
as well.
...
Comments
...
Tab
A message can be added to the work item on build or deployments which would display here. The message itself is customized on the project.
...
Attachments
...
Tab
A relevant files can be added to the work item in this section such as a design document or data. Previews for the attachments are available if the file type is supported.
...
Commits
...
Tab
If the project is configured for source control, then commits or revisions will display here. The id marked #1 is a link back to the build execution summary and the hash number marked #2 is a link to the commit in the external source control provider if it is supported (i.e. For Git, this would be a Github, Gitlab, Bitbucket commit url).
...
Work Item Status
The work item status indicates its current place in the project’s development cycle. Users can click and select an option from the dropdown to change the status of the work item. You can also configure FlexDeploy to change the status automatically on a build or deployment execution.
...
Configure your own statuses based on your business requirements from the main Work Item screen under the administration section.
...
A work item status is essentially a label with name and description.
...
Work Item Types
Work item type is a container for the work item. You can use types to group your work items together in a way that makes sense for your team or company. I.E. If the work item or to fix some defect in your code base, then “Bug” would make sense as the work item type.
By default, FlexDeploy will come with “Feature”, “Bug”, “Debt”, and “Risk” types out of the box. You can choose to use to keep using those types or scrap them and create your own.
...
Work Item Fields
Work Item Fields are used to provide additional information to your work item. To create a field:
Select a Work Item Field Group or create a new one. The name of the field group will display after the “Commits” section when viewing a work item.
Create a new field.
Customize the field with various parameters and/or groovy validations. This is the definition of the field, while the value is set on the work item.
...
There are many options in the field available. It is important to note that “Work Item Types” is the list of types this field will be applied to. Additionall, if the field has “Required” enabled, then the work item in question must have this field set for the status to be changed. It is also im
...
...