Build project management

Available in Classic and VPC

You can run builds for projects created in the NAVER Cloud Platform console. You can also change the settings or delete the project.

Run build

To run the created build project:

1. In the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceBuild.
2. Click the name of the build project to run.
   • Or click [Go to build] while selecting the build project.
3. When the build execution interface appears, check the entered information and edit it if necessary.
   • What you edit in the build execution interface is applied only once when running the build, and it is not saved.
4. Check the SourceBand issue linking information for this build run.
5. To link this build run to a SourceBand issue, select Link.
   • To select a SourceBand issue to link, click [Select issue].
   • In the SourceBand issue linking popup, search for the issue to link and add it.
   Note

   • To link a SourceBand issue, you need to subscribe to the SourceBand service.
   • The SourceBand issue linking information is not saved and only applies to this build run.
6. Click [Start build].
   
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 artifact.
   • Success: Status in which build running is completed and the final artifact 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:

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

Check build result

To check the build running result and detailed logs:

1. In the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceBuild.
2. Click the name of the build project to check the result.
   • Or click [Go to build] while selecting the build project.
3. When the build execution interface appears, click the [Task result] tab.
4. Check the build running result.
   
   • Build number: Unique number assigned when the build is run.
   • Requester: Account credentials of the build running requester.
   • Request time: Time when the requester submitted the build run request.
   • Completion time: Time when the build run was completed.
   • Status: Build run status.
     • Prepare: Status of running the build.
     • Upload: Status of saving the build artifact.
     • Success: Status in which build running is completed and the final artifact 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.
   • File Safer: Malware scan result of the build artifact displayed when File Safer integration is enabled.
   • Build artifact: Click [Download] to download the build artifact created in the zip format.
   • Build log: View logs for each build execution step.
     • The status of each step is displayed by icon color, with up to 4000 lines shown per step.
       • Yellow: In progress.
       • Green: Success.
       • Red: Failure.
     • During the build run, logs are automatically scrolled and displayed in real time. If you click another step or scroll manually, automatic scrolling stops.

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 artifact. To view the result:

1. Click in the FileSafer column in the task result list.
2. Check the File Safer scan result in the File Safer result check popup.

Change build settings

You can change the settings for the build project created. To change the settings:

1. In the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceBuild.
2. Select the project to change the settings for, and click [Change settings].
3. When the build project settings interface appears, change the settings categorized as follows as needed, and click [Apply].
   • Basic information
   • Build environment
   • Build command
   • Upload build artifact
   • Upload image after completing build
   • Related services

Basic information

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

• Build project name: Name of the build project which cannot be edited.
• Build project description: Description for the build project. Enter within 500 characters.
• Build target: Select the build target type and set details.
  • When selecting SourceCommit, set the following items:
    • Repository: Select the repository where the build target code is saved.
    • Branch: Select the build target repository branch.
  • When selecting Github, click [Log in] and set the following items:
    • Click [Log in] and log in using OAuth authentication or a personal access token.
      • OAuth: Click [Log in with GitHub] and enter your GitHub account credentials.
      • Personal access token: Enter the personal access token value issued in GitHub and click [Log in with GitHub].
    • 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 [Log in] and set the following items:
    • Navigate to [Log in] > [Log in to Bitbucket] and enter your Bitbucket account credentials or use an 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 [Log in] and set the following items:
    • Enter one of the following authentication information and click [Log in to Github Enterprise Server]:
      • OAuth: Enter the Github Enterprise Server URL from which to import the repository and the Client ID and Client Secret of the OAuth App created on the server.
      • Personal access token: Enter the GitHub Enterprise Server URL from which to import the repository and the Personal Access Token created on the server.
      • Username/Password: Enter the GitHub Enterprise Server URL from which to import the repository and the account credentials for the server.
      • SSH Key: Enter the Git repository URL in SSH protocol format and the SSH Private key and passphrase for authentication. (Enter the passphrase only if a passphrase is set for the SSH key.)
    Note

    • If communication with the Github Enterprise Server is not available due to firewall settings or other reasons, this repository type cannot be used.
    • The Github Enterprise Server URL can be entered with an IP address or hostname, and the environment must be public.
    • Unlike other login methods, SSH key login allows access only to the repository specified in the entered Git repository URL.
    • GitHub Enterprise Server official guides
      • OAuth App creation guide
      • When configuring an OAuth App, set the callback URL to match the Region. The URLs for each Region are 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 that stores the code you want to build.
    • 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. Refer to the guide for 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:

• OS: Operating system of the build environment. Select only Ubuntu 16.04 (x64).
• Computing type: Computing type for the build environment. Pricing information varies depending on the build environment.
• Build runtime: Select build runtime.
• Build runtime version: Select the version of the selected build runtime.
  • Available build runtimes and versions.

• Timeout: Enter the timeout duration.
• Environment variables: Click [View environment variables] and add the name and value of each environment variable.
• Installed packages: Click [View list] to check the selected build runtime and key package list installed in the version.
• Docker image build: Select to build a Docker image.
• Docker engine version: Displayed when Docker image build is selected. Select the Docker engine version 20.10.18 provided by 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 for the build environment. Pricing information varies depending on the build environment.
• Timeout: Enter the timeout duration.
• Environment variables: Click [View environment variables] and add the name and value of each environment variable.
• Docker image build: Select to build a Docker image.
• Docker engine version: Displayed when Docker image build is selected. Select the Docker engine version 20.10.18 provided by 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 use. 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 use.
  • Enter up to 80 characters using letters, numbers, periods, hyphens, and/or underscores.
  • Use a letter or number for the first character.
• Computing type: Computing type for the build environment. Pricing information varies depending on the build environment.
• Timeout: Enter the timeout duration.
• Environment variables: Click [View environment variables] and add the name and value of each environment variable.
• Docker image build: Select to build a Docker image.
• Docker engine version: Displayed when Docker image build is selected. Select the Docker engine version 20.10.18 provided by SourceBuild.

Build command

You can click [View command] 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 to build 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-level directory of the source code to the Dockerfile.
    • 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 the registry to store the built Docker image.
  • Image name: Enter the name of the image to store.
    • Enter up to 200 characters using lowercase letters, numbers, periods, hyphens, and/or underscores.
    • Use a lowercase letter or number for the first and last characters.
    • Periods cannot be used consecutively, but consecutive use of the underscore is allowed up to two times.
  • Image tag: Enter image tag.
    • Enter up to 80 characters using letters, numbers, and special characters (period, hyphen, underscore, and/or #).
    • Use a letter, number, or # for the first character.
    • The entered # is replaced with an incrementing number starting from 1 during the build, and consecutive # characters are treated as a single entry.
  • Set to latest tag: Select to add latest tag.

Upload build artifact

If you select Save artifact, you can change the following settings:

• Build artifact path: Click [View path] to enter the directory path or file path to save the artifact.
  • Multiple artifacts are distinguished by line breaks.
• Object Storage to upload to: Select the bucket used to store the artifact.
• Object Storage folder path: Enter the directory path in Object Storage where the artifact is stored.
• File name to be saved: Enter the file name to be used when saving as zip.
  • If the bucket is locked, file names identical to those already stored in the bucket cannot be used.
• Artifact backup: Select whether to store a backup copy of the artifact.
  • Backup storage path: /sourcebuild_backup/{build-id}

Upload image after completing build

If you select Save image, you can change the following settings:

• Container registry: Select the registry to store the completed image.
• Image name: Enter the name of the image to store.
  • Enter up to 200 characters using lowercase letters, numbers, periods, hyphens, and/or underscores.
  • Use a lowercase letter or number for the first and last characters.
  • Periods cannot be used consecutively, but consecutive use of the underscore is allowed up to two times.
• Image tag: Enter image tag.
  • Enter up to 80 characters using letters, numbers, and special characters (period, hyphen, underscore, and/or #).
  • Use a letter, number, or # for the first character.
  • The entered # is replaced with an incrementing number starting from 1 during the build, and consecutive # characters are treated as a single entry.
• Set to latest tag: Select to add latest tag.

Related services

You can connect related services with the build project created.

• File Safer (File Filter) integration: Select whether to integrate File Safer to scan build artifacts for malicious code.
• 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 the build project:

1. In the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceBuild.
2. Select the project to delete and click [Delete].
3. When the build project deletion popup appears, click [Delete].