Help Center/ CodeArts Check/ Best Practices/ Checking Code from Git with Preset Rules
Updated on 2024-10-10 GMT+08:00

Checking Code from Git with Preset Rules

Scenario

Check Java code from Git to protect quality.

Preparation

  • You have obtained permissions of CodeArts Check.
  • There is Java code in the Git repository.

Process

Table 1 Process

No.

Step

Description

1

Creating a Project

Create a project.

2

Creating a Git Service Endpoint

Use a service endpoint to connect to a third-party repository.

3

Creating a Task to Check Code from Git

Create a task.

4

Executing the Task

Execute a task.

5

Viewing Check Results

View check results.

Creating a Project

  1. Log in to the Huawei Cloud console.
  2. Click in the upper left corner and choose Developer Services > CodeArts from the service list.
  3. Click Access Service.
  4. Click Create Project, and select the Scrum template. Set the project name to Scrum01 and retain the default values for other parameters.
  5. Click OK to access the project.

Creating a Git Service Endpoint

A service endpoint is an extension to CodeArts and supports connection to third-party repositories.

With a service endpoint, CodeArts Check supports repositories either of CodeArts Repo and third-parties.

  1. Enter a task through a project. In the navigation pane, choose Settings > General > Service Endpoints.
  2. Click Create Endpoint and choose Git repository from the drop-down list.
  3. Configure the following information and click Confirm.

    Table 2 Creating a Git service endpoint

    Parameter

    Description

    Service Endpoint Name

    Enter a maximum of 256 characters, including letters, digits, hyphens (-), underscores (_), periods (.), and spaces. For example, Endpoint01.

    Git Repository URL

    Enter the HTTPS address of the Git repository to connect.

    Username

    Enter the username of the Git repository to connect (max. 300 characters).

    Password or Access Token

    Enter the password of the Git repository to connect (max. 300 characters).

Creating a Task to Check Code from Git

  1. In the navigation pane, choose Code > Check.
  2. Click Create Task. Set parameters by referring to the following table.

    Table 3 Task parameters

    Parameter

    Description

    Project

    Project that the task belongs to. Retain the default value (the Scrum01 project created in Creating a Project).

    Code Source

    Select Git.

    Name

    Customize a task name, for example, CheckTask01.

    Endpoint

    Select the Endpoint01 service endpoint created in Creating a Git Service Endpoint.

    Repository

    Retain the default value.

    Branch

    Retain the default value master.

    Language

    Select the code language to be checked, for example, Java.

  3. Click Create Task.

Executing the Task

  1. In the Tasks page, click to execute the task.
  2. Wait until the task is complete as prompted.

Viewing Check Results

  1. In the Tasks page, search for the CheckTask01 task created in Creating a Task to Check Code from Git.
  2. Click the task name to view the check details, including overview, issues, metrics, logs, and settings.