Skip to content

Commit 38a99b0

Browse files
committed
Update README.md
1 parent 4f8a80d commit 38a99b0

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

+35-3
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ In Cucumber files, the configuration item type is always `Test Case`.
137137

138138
Traceability to other configuration items is used to define the relationship between configuration items. Depending on the configuration item type, different fields are used for this purpose.
139139

140-
Here is the list of all possible fields that can be used in Markdown files:
140+
Here is the list of all possible fields that can be used in **Markdown** files:
141141

142142
```
143143
itemAffects
@@ -160,6 +160,38 @@ itemTriggers
160160
itemIsTriggeredBy
161161
```
162162

163-
In Cucumber files, every tag that starts with `@tests:` is considered to be a traceability field and its always `itemTests`.
163+
In **Cucumber** files, every tag that starts with `@tests:` is considered to be a traceability field and its always `itemTests`.
164164

165-
TBD: Add more information about traceability fields.
165+
### Git-based configuration items traceability to Jira-based configuration items
166+
167+
In a **Markdown** file, it is possible to define traceability between Git-based and Jira-based configuration items. For example, it is possible to define that a Software Item Spec, whose content is managed in a Git repository, fulfills a Requirement that is managed in Jira. In order to do this, define the `itemFulfills` field in the metadata of the Software Item Spec. The value of the `itemFulfills` field must be the Jira issue key.
168+
169+
```
170+
---
171+
itemFulfills: KP-42
172+
itemHasParent: KP-40
173+
---
174+
```
175+
176+
For **Cucumber** files, its enough to use the Jira issue key as a tag, e.g. `@tests:KP-42`.
177+
178+
### Git-based configuration items traceability to other Git-based configuration items
179+
180+
In a **Markdown** file, it is possible to define traceability between Git-based configuration items. For example, it is possible to define that a Software Item Spec, whose content is managed in a Git repository, fulfills a Requirement that is also managed in the same Git repository. In order to do this, define the `itemFulfills` field in the metadata of the Software Item Spec. The value of the `itemFulfills` field must be the `itemId` of the Requirement.
181+
182+
```
183+
---
184+
itemFulfills: some-unique-string-1234
185+
itemHasParent: some-unique-string-1235
186+
---
187+
```
188+
189+
For **Cucumber** files, its enough to use the `@tests:` tag with the `itemId` of the Requirement, e.g. `@tests:some-unique-string-1234`.
190+
191+
### Jira-based configuration items traceability to Git-based configuration items
192+
193+
All configuration items that are managed in a Git repository and synced with Ketryx are automatically exposed in Jira select fields for item relations. Thus, if a configuration item is defined in a Git repository and synced with Ketryx, it will be available in the select field of the Jira issue. For example, if a Task, whose content is managed in Jira, implements a Software Item Spec that is managed in a Git repository, you can select the Software Item Spec from the Git repository in the select field of the Task issue.
194+
195+
## Versioning
196+
197+
Every Git-based configuration item is associated with a version of the Git repository. The version is determined by the release ref pattern or a branch that is defined during the project creation or editing process. For example, if the release ref pattern is set to `refs/tags/v#`, the version of the Git-based configuration item will be determined by the tag name. If the tag name is `v1.0.0`, the version of the Git-based configuration item will be `1.0.0`.

0 commit comments

Comments
 (0)