Debugging Pipeline

• When is Debugging Pipeline Needed?
• How to use it?
• Debugging Tips

When is Debugging Pipeline Needed?

When executing user-defined scripts inside a docker container, inconsistencies between the local and CI environments may arise. In such cases, issues may occur during CI builds while everything works fine locally. To troubleshoot these issues, you can use the "Login Debug" feature, which allows you to log in to the pipeline's docker container for debugging purposes.

How to use it?

Before each pipeline execution, a pipeline docker container is launched to execute user scripts. By default, the docker container is destroyed after the build is completed. However, when the pipeline build environment exists, you can log in to the docker container for debugging purposes.

Debugging pipeline is available in the following two scenarios:

1. During the build process, you can log in for debugging.

2. At the end of the build in Debug mode.

   On the log page, select the "Debug" option next to the "Rebuild" button, and then click the "Rebuild" button. In the newly triggered build, if you haven't logged in for debugging, the build environment will be preserved for 5 minutes. During this time, you can log in for debugging. Afterward, the system will periodically check if any users are logged in for docker debugging. If no one is logged in, the environment will be automatically destroyed. However, if someone is logged in, the environment will continue to be preserved. The build environment is kept for a maximum of 1 hour.

Debugging Tips

When clicking the "Rebuild" button, you can select the specific Pipeline, Stage, or Job that needs to be executed. This helps developers reproduce the problem environment more easily.