On this page

Show all

Help Center/ CodeArts Build/ FAQs/ Using Maven for Build/ Configuring and Clearing Maven Build Cache

Configuring and Clearing Maven Build Cache

Updated on 2023-11-28 GMT+08:00

View PDF

CodeArts Build allows you to cache the dependencies in your private storage space. Once cached, the dependencies will not have to be pulled for future builds. It greatly accelerates builds.

Configuring Cache Setting

When a build task is created, the cache acceleration build is selected by default. You can determine whether to use the cache when configuring the Maven build action.

Clearing Cache

Network jitter, concurrent builds, or other extreme conditions may result in abnormal cache. Consequently, build errors may occur. The following describes how to clear the abnormal cache.

NOTICE:

Before clearing cache, make sure you are well aware of the following precautions:

The cache directory is shared by multiple users of the same tenant. If the cache is frequently cleared, exceptions (usually xxx file does not exist) may occur during other users' builds. Therefore, this operation can be performed only when the cache is abnormal. After the task succeeds, edit the task to delete the cache clearing command. While clearing the cache, do not run other build tasks that use the cache.
An accurate file path is required for clearing the cache. For example, to clear the demo 1.0.0 of vendor XXX, run the rm -rf /path/com/xxx/demo/1.0.0 command. If the level of the directory entered in the cache clearing command is too high, the next build will be slow or the dependency will be abnormal due to network problems.
For security purposes, the cache clearing command can be executed only in the Build with Maven action. If this command is executed in other actions, the clearing operation may not succeed or an error will be displayed (for example the directory does not exist).

Click on the build tasks page.
Choose Build Actions > Build with Maven. Locate the line starting with mvn xxxx in the commands.
Enter the cache clearing command in front of mvn xxx and click Save.

The format of the cache clearing command is rm -rf /repository/local/maven/{groupId}/{artifactId}/{version}. The parameters to be entered correspond to groupId, artifactId, and version in the dependency package coordinates. The dots in groupId are automatically divided into hierarchical directories.
For example, if the dependency package is as follows:
```
<dependency>
<groupId>com.xxx.xxx</groupId>
<artifactId>demo</artifactId>
<version>1.0.9-SNAPSHOT</version>
</dependency>
```
The command for clearing the package is rm -rf /repository/local/maven/com/xxx/xxx/demo/1.0.9-SNAPSHOT.
Run the build task again. After the task succeeds, edit the task again and remove the cache clearing command.

Parent topic: Using Maven for Build

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel