Help Center/ CodeArts Repo/ User Guide/ Creating and Configuring a CodeArts Project/ E2E Settings
Updated on 2024-12-12 GMT+08:00
View PDF
Share

E2E Settings

Repo uses this E2E tracing setting to log code merge reasons, such as implementing a requirement, fixing a bug, or completing a work item. Association is enabled by default.

Integrated Systems

It integrates with CodeArts Req and uses work items in CodeArts Req to associate with code commits.

The repositories of Kanban projects do not support E2E settings.

Integration Policies

(Optional) Specify available selection conditions when you associate with a work item.

Excluded States: States of work items that CANNOT be associated with.

Associable Types: Types of work items that can be associated with.

Applicable Branches: Branches to comply with preceding restrictions.

Automatic ID Rules Extraction

Automatic ID extraction rules (automatically extracting ticket numbers based on code commitment information) are as follows:

  • ID Prefix: (Optional) A maximum of 10 prefixes are supported, for example, [Trouble ticket number or Requirement ticket number].

    If ID Prefix, Separator, and ID Suffix are not empty, the automatic ticket number extraction function is enabled by default.

  • Separator: (Optional) The default value is a semicolon (;).
  • ID Suffix: (Optional) The default value is a newline character.
    • The values of ID Prefix, Separator, and ID Suffix cannot be the same.
    • If Separator is left empty, the values of ID Prefix and ID Suffix cannot be semicolon (;).
    • If ID Suffix is left empty, the values of ID Prefix and Separator cannot be \n.
    • The values of ID Prefix, Separator, and ID Suffix are matched in full character mode. Regular expressions are not supported.

Examples

  1. Configure E2E settings.

    1. Go to the target repository.
    2. Choose Settings > Service Integration > E2E Settings. The E2E Settings page is displayed.

    3. Configure the following integration policies and click Submit.

      Applicable Branches: Select the target branch, for example, branch.

      ID Prefix: user-defined prefix, for example, Incorporated requirements.

  2. Create a work item.

    1. Click the target project name to access the project.
    2. On the current Work Items tab, click Create Work Item and choose Task from the drop-down list box. The page for creating a work item is displayed.

    3. Enter a title, for example, Sprint 1.

      Retain the default values for other parameters. Click Save.

  3. Create a File.

    1. Go to the repository list page and click the name of the target repository.
    2. On the Code tab, click Create and choose Create File from the drop-down list box. The page for creating a file is displayed.

    3. Enter the following information, retain the default values for other parameters, and click OK.

      File name: user-defined file name, for example, Sample_Code.

      File content: user-defined file content.

      Commit message: Enter the prefix and work item number in the E2E settings, for example, 708635317.

  4. Extract the ticket number when creating a merge request.

    1. Switch to the Merge Requests tab and click New.
    2. Select Dev as the source branch and master as the target branch, and click Next. The page for creating a merge request is displayed.

      At this point, the work item is automatically extracted to the merge request.