Create a build project

Available in Classic and VPC

To create a build project from the NAVER Cloud Platform console:

1. In the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceBuild.
2. Click [Create build project].
3. Check if Object Storage is selected as In use in Prerequisites and click [Next].
   • If it is not in use, click to go to the Object Storage interface. Subscribe to the service, create a bucket, and try again.
4. Proceed through the following steps on the interface:
   • 1. Default settings
   • 2. Build environment settings
   • 3. Build command settings
   • 4. Upload settings
   • 5. Additional service integrations
   • 6. Final review

1. Default settings

To set the basic information for the build project to be created:

1. Enter the name and description for the build project to be created.

   • You can only use letters, numbers, hyphens, and underscores　for the name. You cannot enter the name same as that of the build project already created.
   • You can enter the description within 500 characters.

2. Select the build target type and set the details needed.

   • 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 of the SSH protocol format and the SSH Private Key for authentication.
     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.

3. You can set the notification settings for when the build starts and when the build ends.

   • To register the person to be notified when an event occurs, click [Manage notification target] to register in advance.
   • Select the person to be notified when the event occurs and the notification method (SMS, email), then click [Add].
   • To delete a set person, click [Delete] to delete them from the list.

4. Click [Next].

2. Build environment settings

The method to set the build environment varies depending on the selected build environment image's type. Refer to the guide for the selected type.

• 1. Default settings
• 2. Build environment settings
  • Using image managed in SourceBuild
  • Using Container Registry image
  • Using Public Registry image
• 3. Build command settings
• 4. Upload settings
• 5. Additional service integrations
• 6. Final review

Using image managed in SourceBuild

To set a build environment using the image managed in SourceBuild:

1. Select the Image managed in SourceBuild as the build environment image.
2. Select an operating system for the build environment.
   • Only Ubuntu 16.04 (x64) is available.
3. Select the build runtime and runtime version.
   • Available build runtimes and versions.

4. Select Check if you use the Docker build command and select the Docker engine version when building a Docker image.

5. Select the computing type of the build environment.
   • Pricing information varies depending on the build environment.
6. Enter the timeout time.
   • Enter a value between 5 and 540 minutes.
7. If you have an environment variable to add, enter its name and value, and click [Add].
8. Click [Next].

Using Container Registry image

To set a build environment using the image created in Container Registry:

1. Select the Container Registry image as the build environment image.
2. Select the registry where the image is saved.
3. Select a Docker image to use.
4. Select a tag for the image.
5. Select Check if you use the Docker build command and select the Docker engine version when building a Docker image.

6. Select the computing type of the build environment.
   • Pricing information varies depending on the build environment.
7. Enter the timeout time.
   • Enter a value between 5 and 540 minutes.
8. If you have an environment variable to add, enter its name and value, and click [Add].
9. Click [Next].

Using Public Registry image

To set a build environment using the image created in a public registry such as DockerHub:

1. Select the Public Registry's image as the build environment image.
2. Enter the name of the Docker image to use.
   • Enter the name only for images in DockerHub.
   • Enter the name for other images with the registry address included (e.g., sourcebuild.myregistry.com/sourcebuild_image).
3. Enter a tag for the image.
   • Enter up to 80 characters using letters, numbers, periods, hyphens, and/or underscores.
   • Use a letter or number for the first character.
4. Select Check when building a Docker image and select the Docker engine version when building a Docker image.

5. Select the computing type of the build environment.
   • Pricing information varies depending on the build environment.
6. Enter the timeout time.
   • Enter a value between 5 and 540 minutes.
7. If you have an environment variable to add, enter its name and value, and click [Add].
8. Click [Next].

3. Build command settings

To set a build running command:

1. Enter each command to be performed before, during, and after running the build.

   • Available shell: /bin/sh
   • When entering multiple commands, distinguish with line breaks.
   • Perform the command in the top directory of the source code.
   • Build sequence: Provisioning (creating a server) > downloading source code > command before building > command during build > command after building > uploading the artifact.

2. Select whether to use from the Docker image build settings.

   • 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.

3. Click [Next].

4. Upload settings

To set whether to save the build artifact and completed image:

1. Select whether to save the build artifact in Object Storage.
2. If you select Save artifact, set the following items:
   • Build artifact path: 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}
3. Select whether to save the image in the Build completed status.
4. If you select Save image, set the following items:
   • 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.
5. Click [Next].

5. Additional service integrations

You can connect the newly created build with NAVER Cloud Platform's log service and security service. It has the following advantages when connecting an additional service.

• You can check the build logs of only 2 days in SourceBuild, but if you connect with Cloud Log Analytics, a log service, then you can check the build logs of 30 days in Cloud Log Analytics.
• When you connect the security service File Safer, the build artifact is automatically scanned by File Safer upon a successful build to detect whether the artifact contains malicious code.

To set the service connection:

1. Select whether to connect Cloud Log Analytics.
2. Select whether to connect File Safer.
   • Files eligible for scan requests in File Safer.
     • Size: Up to 10 MB
     • Extensions: bat, cmd, vbs, vbe, js, jse, wsf, wsh, html, htm, hta, jsp, php, cgi, ahk, au3, py, lsp, fas, ps, eps, gsf, ps1, sh, exe, dll, com, so, zip, tar, gz, tgz, rar, xz, 7z
   • Shows the previous scan result if there is a scan history with the same hash.
3. Click [Next].

6. Final review

1. Check the build project information set.
   • Click [Previous] to edit the settings.
2. Click [Create].