Managing build project

Available in Classic and VPC

You can run the build of the project you created in NAVER Cloud Platform console. You can also change the settings or delete the project.

Run build

To run the created build project, follow these steps:

1. In the NAVER Cloud Platform console, click Services > Developer Tools > SourceBuild, in order.

2. Click the name of the build project to run.

   • Or click the [Go to build] button while selecting the build project

3. When the Run build page appears, check the entered information and edit it if necessary.

   • What you edit in the Run build page is applied only once when running the build, and it is not saved.

4. Check the SourceBand issue connection information for this build run.

5. To connect this build run to a SourceBand issue, select Connection.

   • To select a SourceBand issue to connect, click the [Select Issue] button.
   • In the SourceBand issue connection pop-up window, search for and add the issue to connect.
   Note

   • To connect a SourceBand issue, you must apply for the SourceBand product.
   • The SourceBand issue connection information is not saved and only applies to this build run.

6. Click the [Start build] button.
   

7. Check the running logs and the build's running status that appear when running the build.

   • For more information on checking the build result, see Check build result
   • Prepare: status of running the build
   • Upload: status of saving the build result
   • Success: status in which build running is completed and the final result is saved
   • Fail: status in which a build failed to run. Details are available in Build logs
   • Canceled: status in which build running is canceled

Cancel build

To cancel a running build, follow these steps:

1. Click the [Cancel] button that appears when running the build.
   
2. Check if the build status is shown as Canceled.

Check build result

To check the build running result and detailed logs, follow these steps:

1. In the NAVER Cloud Platform console, click Services > Developer Tools > SourceBuild, in order.
2. Click the name of the build project to check the result.
   • Or click the [Go to build] button while selecting the build project
3. When the Run build window appears, click the [Task result] tab.
4. Check the build running result.
   
   • Build number: unique number assigned when running the build
   • Requester: account information of the build running requester
   • Requested time: time when the requester requested the build running
   • Completed time: time when the build running was completed
   • Status: status of build running
     • Prepare: status of running the build
     • Upload: status of saving the build result
     • Success: status in which build running is completed and the final result is saved
     • Fail: status in which a build failed to run. Details are available in Build logs
     • Canceled: status in which build running is canceled
   • FileSafer: result of malware code scan done on the build result shown when File Safer is integrated
   • Build result: click the [Download] button to download the build result created in zip format
   • Build log: check the logs for each step of build running
     • Step-specific status is shown as icon color, and up to 4000 lines are shown for each step
       • Yellow: running
       • Green: successful
       • Red: failed
     • You can check the logs being output in real time by auto scrolling while running the build, but the auto scrolling is stopped when clicking another step in the middle of it or scrolling manually

Check result of File Safer

If SourceBuild is connected to File Safer, you can check the result of the malware scan done on the build result. To check the information, follow these steps:

1. Click in the FileSafer column in the task result list.
2. Check the File Safer scan result in the File Safer result check pop-up window.

Change build settings

You can change the settings for the build project created. To change the settings, follow these steps:

1. In the NAVER Cloud Platform console, click Services > Developer Tools > SourceBuild, in order.
2. Select the project to change the settings, and then click the [Change settings] button.
3. When the Set build project page appears, change the settings classified as follows how you want, and then click the [Apply] button.
   • Basic information
   • Build environment
   • Command during build
   • Upload build result
   • Upload image after completing build
   • Connect additional service

Basic information

You can change the basic information for the build project created.

• Build project name: build project's name. It is not editable
• Build project description: description for the build project. Enter within 500 characters
• Build target: select the build target type and set details

  • Set the following items when selecting SourceCommit

    • Repository: select the repository where the build target code is saved
    • Branch: select the build target repository branch

  • When selecting Github, click the [Login] button and set the following items

    • Click the [Log in] button and log in using the OAuth authentication or personal access token
      • OAuth: click the [Log in to GitHub] button and enter the GitHub account information
      • Personal access token: enter the personal access token value issued in GitHub and click the [Log in to GitHub] button
    • Repository: select the repository where the build target code is saved
    • Branch: select the build target repository branch
    Note

    For more information on how to create a personal access token in GitHub, see GitHub's Personal Access Token creation guide.

  • When selecting Bitbucket, click the [Login] button and set the following items

    • Click the [Log in] > [Log in to Bitbucket] buttons in order, then enter the Bitbucket account information or use the OAuth account
    • Workspace: select the workspace where the build target code is located
    • Repository: select the repository where the build target code is saved
    • Branch: select the build target repository branch

  • When selecting Github Enterprise Server, click the [Login] button and set the following items

    • Enter one of the following authentication information and click the [Github Enterprise Server Login] button
      • OAuth: enter the Github Enterprise Server URL for importing the repository and enter the Client Id and Client Secret of OAuth App created in the relevant server
      • Personal Access Token: enter the Github Enterprise Server URL for importing the repository and the Personal Access Token created on the relevant server
      • Username/Password: enter the Github Enterprise Server URL for importing the repository and the user account information of the relevant server
      • SSH Key: enter the Git Repository URL of SSH protocol format and SSH Private Key and Passphrase for authentication (enter the Passphrase when it is set in SSH Key)
    Note

    • If communication with the Github Enterprise Server is not possible due to firewall settings, etc., you cannot use the relevant storage type.
    • The Github Enterprise Server URL can be entered with IP and Hostname and the environment must be public.
    • SSH Key login, unlike other logins, can access only the repository of Git repository URL entered.
    • GitHub Enterprise Server official guide
      • OAuth APP creation guide
      • When setting up an Auth app, set the callback URL suitable to the Region. The URL for each Region is as follows:
        • KR : https://devtools.ncloud.com/ghes/sourcebuild
        • SGN : https://devtools-sg.ncloud.com/ghes/sourcebuild
        • JPN : https://devtools-jp.ncloud.com/ghes/sourcebuild
      • Personal Access Token creation guide
      • SSH key settings guide
    • Owner: select the owner where the build target code is located
    • Repository: select the repository where the build target code is saved
    • Branch: select the build target repository branch

Build environment

The build environment information that can be changed varies, depending on the selected build environment image. See the guide appropriate to the selected type.

• Change settings when selecting SourceBuild image
• Change settings when selecting Container Registry image
• Change settings when selecting Public Registry image

Change settings when selecting SourceBuild image

If you select the Image managed in SourceBuild, then you can change the following settings.

• Operating system: operating system of the build environment. Select only Ubuntu 16.04 (x64)
• Computing type: computing type of the build environment. The usage fee differs by build environment
• Build runtime: select the build runtime
• Build runtime version: select the build runtime's version
  • Available build runtimes and versions

Build runtimes and versions will continue to be updated.

:::

• Timeout: enter the timeout time
• Environment variable: click the [View environment variable] button to add the environment variable's name and value
• Installation package list: click the [View list] button to check the selected build runtime and key package list installed in the version
• Docker image build: select when building a Docker image
• Docker engine version: shown when selecting the Docker image build. Select the Docker engine of the 18.09.01 version provided in SourceBuild

Change settings when selecting Container Registry image

If you select the Container Registry image, you can change the following settings.

• Registry: select the registry where the image is saved
• Image: select the image to be used in the registry
• Tag: select the tag of the image to be used
• Computing type: computing type of the build environment. The usage fee differs by build environment
• Timeout: enter the timeout time
• Environment variable: click the [View environment variable] button to add the environment variable's name and value
• Docker image build: select the item when building a Docker image
• Docker engine version: shown when selecting the Docker image build item. Select the Docker engine of the 18.09.01 version provided in SourceBuild

Change settings when selecting Public Registry image

If you select the Public Registry image, you can change the following settings.

• Image: enter the name of the image to be used. Enter the name only for the DockerHub image. Enter the name for other images with registry address included
• Tag: enter the tag of the image to be used
  • Enter within 80 characters using English letters, numbers, and special characters (period, -, and _)
  • Use an English letter or number for the first character
• Computing type: computing type of the build environment. The usage fee differs by build environment
• Timeout: enter the timeout time
• Environment variable: click the [View environment variable] button to add the environment variable's name and value
• Docker image build: select when building a Docker image
• Docker engine version: shown when selecting the Docker image build. Select the Docker engine of the 18.09.01 version provided in SourceBuild

Command during build

You can click the [View command] button to change the build running command.

• Command before build: enter the command to be performed before running the build
• Command during build: enter the command to be performed while running the build
• Command after build: enter the command to be performed after running the build
• Docker image build settings: select Use when building a Docker image
  • You can select Use only if the Docker image build is selected under the build environment settings
  • Dockerfile path: enter the path from the top directory of the source code to the file name
    • The path of the local file (ADD, COPY, etc.) used within the Dockerfile uses the relative paths starting from the Dockerfile location
  • Container Registry: select a registry to save the built Docker image
  • Image name: enter the name of the image to be saved
    • Enter within 200 characters using lowercase English letters, numbers, and special characters (period, -, and _)
    • Use a lowercase English letter or number for the first and last characters
    • Consecutive periods (.) are not allowed, but two consecutive special characters (_) are allowed
  • Image tag: enter the image tag
    • Enter within 80 characters using English letters, numbers, and special characters (period, -, _, and #)
    • Use an English letter, number, or # for the first character
    • The entered # will be replaced by incremental numbers starting from 1, and consecutive #s entered will be handled as entering a single one
  • Set as latest: pushes the latest tag additionally when selected

Upload build result

If you select Save result, then you can change the following settings.

• Build result path: click the [View path] button to enter the directory path or file path to save the result
  • Multiple results are distinguished by line breaks
• Object Storage to upload: select a bucket to save the result
• Object Storage folder path: enter the directory path to the Object Storage where the result will be stored
• File name to be saved: enter the file name to be used when saving as zip
  • If the bucket is locked, you cannot use the same name as that of the file already saved in the bucket
• Backup result: select whether to save the backup copy of the result
  • Path to save the backup copy: /sourcebuild_backup/{build-id}

Upload image after completing build

If you select Save image, then you can change the following settings.

• Container Registry: select a registry to save the completed image
• Image name: enter the name of the image to be saved
  • Enter within 200 characters using lowercase English letters, numbers, and special characters (period, -, and _)
  • Use a lowercase English letter or number for the first and last characters
  • Consecutive periods (.) are not allowed, but two consecutive special characters (_) are allowed
• Image tag: enter the image tag
  • Enter within 80 characters using English letters, numbers, and special characters (period, -, _, and #)
  • Use an English letter, number, or # for the first character
  • The entered # will be replaced by incremental numbers starting from 1, and consecutive #s entered will be handled as entering a single one
• Set as latest: pushes the latest tag additionally when selected

Connect additional service

You can connect an additional service with the build project created.

• File Safer (File Filter) connection: select whether to connect with File Safer that diagnoses if there's any malware in the build result
• Cloud Log Analytics integration: select whether to integrate with Cloud Log Analytics, where you can check build logs for 30 days

Delete build

You can delete a created build project. To delete it, follow these steps:

1. In the NAVER Cloud Platform console, click Services > Developer Tools > SourceBuild, in order.
2. Select the project to delete and then click the [Delete] button.
3. When the Delete build project pop-up window appears, click the [Delete] button.