<div id="readability-page-1" class="page"><article><div id="contents_list"><h2 id="section">목차</h2><ul><li><a href="#개요">개요</a></li><li><a href="#gitlab에-dependabot-script-추가">GitLab에 dependabot-script 추가</a></li><li><a href="#gitlab-token-생성">GitLab token 생성</a></li><li><a href="#github-token-생성">GitHub token 생성</a></li><li><a href="#cicd-변수-설정">CI/CD 변수 설정</a></li><li><a href="#gitlab-ciyml-파일">.gitlab-ci.yml 파일</a></li><li><a href="#schedule-생성">Schedule 생성</a></li><li><a href="#schedule-실행">Schedule 실행</a></li><li><a href="#error-job-failed-failed-to-pull-image-dependabotdependabot-script">ERROR: Job failed: failed to pull image dependabot/dependabot-script</a></li><li><a href="#완료">완료</a></li></ul></div><h2 id="개요">개요</h2><p><code>Dependabot</code>은 오픈소스로 <code>GitHub</code> 또는 <code>GitLab</code> 등에서 프로젝트에서 사용하는 라이브러리의 버전이 업데이트되면 새로운 버전으로 업데이트할 수 있도록 <code>Pull request(Merge request)</code>를 생성해 주는 도구입니다.</p><ul><li>Dependabot: <a href="https://github.com/dependabot" rel="nofollow noreferrer" target="_blank">https://github.com/dependabot</a></li></ul><p><code>Dependabot</code>은 처음에는 <code>GitHub</code>에서 사용하기 위해 만들어졌지만, 현재는 오픈소스로 어떤 곳에서도 사용할 수 있으며, <code>GitLab</code>에서도 <code>Dependabot</code>을 사용할 수 있도록 지원하고 있다.</p><ul><li>Dependabot for GitLab: <a href="https://gitlab.com/dependabot-gitlab/dependabot" rel="nofollow noreferrer" target="_blank">https://gitlab.com/dependabot-gitlab/dependabot</a></li></ul><p>하지만, <code>GitLab</code>에서는 <code>Ultimate</code> 요금제를 사용하지 않으면 <code>GitLab</code>이 제공하는 기본적인 <code>Dependabot</code>을 사용할 수 없다.</p><ul><li>Dependency Scanning <a href="https://docs.gitlab.com/ee/user/application_security/dependency_scanning/" rel="nofollow noreferrer" target="_blank">https://docs.gitlab.com/ee/user/application_security/dependency_scanning/</a></li></ul><p>이번 블로그 포스트에서는 <code>GitLab</code>의 <code>Ultimate</code> 요금제가 아닌 <code>self-managed</code>에서 <code>Dependabot</code>을 사용하는 방법에 대해서 알아봅시다.</p><h2 id="gitlab에-dependabot-script-추가">GitLab에 dependabot-script 추가</h2><p><code>GitLab</code>에 <code>Dependabot</code>을 실행하기 위해서는 <code>Dependabot</code>을 실행할 수 있는 환경을 구성해야 합니다. <code>Dependabot</code>은 간단히 <code>Dependabot</code>을 실행할 수 있는 환경을 <code>dependabot-script</code> 리포지토리로 제공하고 있습니다.</p><ul><li><a href="https://github.com/dependabot/dependabot-script" rel="nofollow noreferrer" target="_blank">dependabot-script</a></li></ul><p>다음 순서를 통해 <code>GitLab</code>에 <code>dependabot-script</code> 리포지토리를 추가합니다.</p><ol><li>GitLab 접속</li><li>New Project</li><li>Import project</li><li>Repository by URL</li></ol><p>그리고 <code>Repository URL</code>에 <code>dependabot-script</code>의 리포지토리 URL을 입력하여 추가합니다.</p><ul><li>Repository URL: https://github.com/dependabot/dependabot-script</li></ul><h2 id="gitlab-token-생성">GitLab token 생성</h2><p><code>dependabot-script</code> 리포지토리에서 다른 리포지토리의 라이브러리의 버전을 검사하고, 새로운 버전이 있는 경우 <code>Merge request</code>를 자동으로 만듭니다. 따라서 다른 리포지토리에 접근하고 <code>Merge request</code>를 만들기 위한 <code>Personal Access Tokens</code>이 필요합니다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/personal_access_tokens.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/personal_access_tokens.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/personal_access_tokens.png" alt="GitLab Dependabot - personal access tokens"></picture><p><code>api</code> 권한을 가진 <code>Personal Access Token</code>을 생성합니다.</p><h2 id="github-token-생성">GitHub token 생성</h2><p><code>dependabot-script</code> 리포지토리는 <code>GitHub</code>의 <code>API</code>를 사용하여 라이브러리의 버전을 검사합니다. 따라서 <code>GitHub</code>의 <code>API</code>를 사용하기 위해 <code>GitHub</code>의 <code>Personal access token</code>을 생성할 필요가 있습니다.</p><p><code>GitHub</code>에 로그인 한 후, 오른쪽 상단에 프로필 이미지를 선택합니다. 그 다음 <code>Settings</code>를 선택하여 설정 화면으로 이동합니다.</p><p>설정 화면에서 왼쪽 메뉴 리스트의 제일 하단의 <code>Developer settings</code>을 선택합니다. 그 다음 <code>Personal access tokens</code> &gt; <code>Token (classic)</code>을 눌러 <code>Token</code> 생성 화면으로 이동합니다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/github_personal_access_token.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/github_personal_access_token.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/github_personal_access_token.png" alt="GitLab Dependabot - GitHub personal access tokens"></picture><p><code>Token</code>은 <code>repo</code>의 <code>public_repo</code> 권한을 설정한 후, 생성합니다.</p><h2 id="cicd-변수-설정">CI/CD 변수 설정</h2><p>이렇게 생성한 <code>Personal Access Token</code>을 <code>dependabot-script</code>의 <code>CI/CD</code> 변수에 설정할 필요가 있습니다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/ci_cd_variables.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/ci_cd_variables.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/ci_cd_variables.png" alt="GitLab Dependabot - add token to CI/CD variables"></picture><p><code>dependabot-script</code> 리포지토리에서 <code>Settings</code> &gt; <code>CI/CD</code> &gt; <code>Variables</code>의 <code>Expand</code>를 클릭합니다.</p><p>그리고 앞서 만든 <code>GitLab</code>의 <code>Personal Access Token</code>을 <code>GITLAB_ACCESS_TOKEN</code>을 <code>key</code>로 추가합니다.</p><ul><li>Key: GITLAB_ACCESS_TOKEN</li><li>Value: token</li></ul><p>또한, <code>GitHub</code>의 <code>Personal Access Token</code>을 <code>GITHUB_ACCESS_TOKEN</code>을 <code>key</code>로 추가합니다.</p><ul><li>Key: GITHUB_ACCESS_TOKEN</li><li>Value: token</li></ul><p>만약 <code>self-managed</code>인 <code>GitLab</code>을 사용한다면, <code>GITLAB_HOSTNAME</code>을 함께 설정할 필요가 있습니다.</p><ul><li>Key: GITLAB_HOSTNAME</li><li>Value: gitlab.dev-yakuza.com</li></ul><h2 id="gitlab-ciyml-파일">.gitlab-ci.yml 파일</h2><p><code>dependabot-script</code> 리포지토리를 보면 <code>.gitlab-ci.example.yml</code> 파일이 있습니다. 이 파일의 이름을 <code>.gitlab-ci.yml</code>으로 변경합니다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/gitlab_ci_yml.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/gitlab_ci_yml.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/gitlab_ci_yml.png" alt="GitLab Dependabot - rename .gitlab-ci.example.yml to .gitlab-ci.yml"></picture><h2 id="schedule-생성">Schedule 생성</h2><p>이제 <code>Dependabot</code>을 일정 주기로 실행하여 사용하여 특정 프로젝트에서 사용하는 라이브러리의 버전을 확인하고, 새 버전이 있는 경우 <code>Merge request</code>를 생성하도록 만들어야 합니다.</p><p>그럼 다음과 같이 <code>dependabot-script</code> 리포지토리에 새로운 <code>Schedule</code>을 추가합니다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/schedule_pipeline.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/schedule_pipeline.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/schedule_pipeline.png" alt="GitLab Dependabot - create a new schedule of pipeline"></picture><p>이때, <code>Variables</code>에 특정 프로젝트의 <code>Path</code>와 해당 프로젝트에서 사용하는 <code>Package manager</code>를 설정할 필요가 있습니다.</p><ul><li>PROJECT_PATH: <namespace>/<project> (ex&gt; dev-yakuza/deku-nextjs-boilerplate)</project></namespace></li><li>PACKAGE_MANAGER_SET: project manager (ex&gt; npm_and_yarn)</li></ul><p><code>dependabot-script</code>에서 설정 가능한 <code>Package manager</code>의 리스트는 다음의 링크를 통해 확인할 수 있습니다.</p><ul><li>PACKAGE_MANAGER: <a href="https://github.com/dependabot/dependabot-script#environment-variables" rel="nofollow noreferrer" target="_blank">https://github.com/dependabot/dependabot-script#environment-variables</a></li></ul><p>사용 가능한 <code>Package manager</code>는 다음과 같습니다.</p><ul><li>bundler</li><li>cargo</li><li>composer</li><li>dep</li><li>docker</li><li>elm</li><li>go_modules</li><li>gradle</li><li>hex</li><li>maven</li><li>npm_and_yarn</li><li>nuget</li><li>pip (includes pipenv)</li><li>submodules</li><li>terraform</li></ul><h2 id="schedule-실행">Schedule 실행</h2><p>그럼 <code>Schedule</code>을 실행하여 실제로 <code>Dependabot</code>이 잘 작동하는지 확인해 봅시다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/start_schedule_pipeline.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/start_schedule_pipeline.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/start_schedule_pipeline.png" alt="GitLab Dependabot - create a new schedule of pipeline"></picture><p>문제가 없다면 <code>PROJECT_PATH</code>에 설정한 리포지토리에 다음과 같이 <code>Merge request</code>가 생성된 것을 확인할 수 있습니다.</p><picture><source srcset="/assets/images/category/gitlab/dependabot/merge_request.avif" type="image/avif"><source srcset="/assets/images/category/gitlab/dependabot/merge_request.webp" type="image/webp"><img src="https://deku.posstree.com/assets/images/category/gitlab/dependabot/merge_request.png" alt="GitLab Dependabot - merge request"></picture><h2 id="error-job-failed-failed-to-pull-image-dependabotdependabot-script">ERROR: Job failed: failed to pull image dependabot/dependabot-script</h2><p>기본적으로 <code>.gitlab-ci.yml</code> 파일의 내용은 변경할 필요가 없습니다. 하지만, <code>GitLab</code> 서버 설정에 따라 다음과 같은 에러가 발생할 수 있습니다.</p><div><pre><code>ERROR: Job failed: failed to pull image "dependabot/dependabot-script" with specified policies [always]: Error response from daemon: pull access denied for dependabot/dependabot-script, repository does not exist or may require 'docker login': denied: requested access to the resource is denied (manager.go: 237:2s)
</code></pre></div><p>이런 경우 <code>.gitlab-ci.yml</code> 파일을 다음과 같이 수정합니다.</p><div><pre><code><span># build-image:</span>
<span>#   tags:</span>
<span>#     - shell</span>
<span>#   stage: build</span>
<span>#   script:</span>
<span>#     - docker build -t "dependabot/dependabot-script" -f Dockerfile .</span>

<span>.dependabot</span><span>:</span>
  <span>tags</span><span>:</span>
    <span>-</span> <span>docker</span>
  <span>image</span><span>:</span> <span>dependabot/dependabot-core</span>
  <span>before_script</span><span>:</span>
    <span>-</span> <span>bundle install -j $(nproc) --path vendor</span>
  <span>variables</span><span>:</span>
    <span>PACKAGE_MANAGER</span><span>:</span> <span>$CI_JOB_NAME</span>
  <span>script</span><span>:</span>
    <span>-</span> <span>bundle exec ruby ./generic-update-script.rb</span>
  <span>only</span><span>:</span>
    <span>-</span> <span>schedules</span>
</code></pre></div><p>이렇게 수정하고 <code>Schedule</code>을 실행하면 문제없이 <code>Merge request</code>가 생성되는 것을 확인할 수 있습니다.</p><h2 id="완료">완료</h2><p>이것으로 <code>Ultimate</code> 요금제가 아닌 <code>self-managed</code>용 <code>GitLab</code>에 <code>dependabot-script</code>을 사용하여 <code>Dependabot</code>을 설정하고 실행하는 방법에 대해서 살펴보았습니다. 최신 버전의 라이브러리를 사용하면 보안 문제를 해결할 수 있으며, 갑작스럽게 대규모 버전 업데이트를 할 필요가 없으므로 버전 업데이트에 많은 시간을 투자할 필요가 없습니다.</p><p><code> 제 블로그가 도움이 되셨나요? 하단의 댓글을 달아주시면 저에게 큰 힘이 됩니다! </code></p><h2>앱 홍보</h2><div><p> 지금 보고 계신 블로그를 작성하는 <code>Deku</code>가 개발한 앱을 한번 사용해보세요.<br><code>Deku</code>가 개발한 앱은 Flutter로 개발되었습니다.</p><p> 관심있으신 분들은 앱을 다운로드하여 사용해 주시면 정말 감사하겠습니다.</p></div><h2>책 홍보</h2></article></div>

dev-yakuza

GitLab에 Dependabot을 추가하여 프로젝트에서 사용하는 라이브러리 버전 업데이트를 자동화하는 방법에 대해서 설명합니다.

[GitLab] Dependabot

댓글