툴체인에서 GitHub 를 소스 리포지토리로 구성하기
Continuous Delivery 2027년 2월 12일부로 다음 지역에서 서비스가 중단됩니다: au-syd, ca-tor, us-east. 또한 해당 날짜를 기점으로 Code Risk Analyzer는 모든 지역에서 서비스가 중단될 예정입니다. 특정 지역에서 해당 기능을 실제로 사용하지 않는 경우, 해당 지역의 기능은 예정보다 일찍 중단될 수 있으며 새로운 인스턴스 등록이 더 이상 허용되지 않을 수 있습니다. 자세히 알아보기
IBM Cloud 툴체인에서 GitHub 를 구성하여 소스 코드를 관리하고, 풀 리퀘스트를 통해 협업하며, 코드 변경 시 파이프라인 실행을 트리거할 수 있습니다.
GitHub Enterprise는 Git 저장소를 위한 온프레미스 웹 기반 호스팅 서비스입니다.
GitHub Issues는 작업과 플랜을 모두 한 위치에 보관하는 추적 도구입니다. 개발 저장소에 통합되므로 중요한 태스크에 집중할 수 있습니다.
GitHub.com의 새 저장소 또는 기존 저장소에서 소스 코드를 관리하거나 회사의 GitHub Enterprise 인스턴스에서 소스 코드를 관리할 수 있도록 GitHub를 도구 체인의 도구 통합으로 구성할 수 있습니다. 위키, 문제 추적 및 가져오기 요청을 통해 소셜 코딩에 참여하십시오.
도구 체인을 작성할 때 이 도구 통합을 구성하는 경우 다음 단계를 따르십시오.
-
GitHub 저장소에 소스 코드를 저장 중인 경우 구성 가능한 통합 섹션에서 GitHub를 클릭하십시오. IBM Cloud Public에서 이 도구 연동을 구성하는 경우, OAuth, 개인 액세스 토큰 또는 GitHub 앱 중 하나를 선택하여 IBM Cloud 이 GitHub 에 액세스할 수 있도록 권한을 부여해야 합니다.
-
OAuth 를 선택한 경우 인증을 클릭하여 GitHub 웹사이트로 이동합니다. 활성 GitHub 세션이 없으면 로그인을 요구하는 프롬프트가 표시됩니다. 애플리케이션에 권한 부여를 클릭하여 IBM Cloud에서 사용자의 GitHub 계정에 액세스할 수 있도록 허용하십시오. 활성 GitHub 세션이 있지만 최근에 비밀번호를 입력하지 않은 경우, 확인을 위해 GitHub 비밀번호를 입력하도록 프롬프트가 표시될 수 있습니다.
-
개인 액세스 토큰을 선택하는 경우 GitHub 를 사용하여 저장소를 복제하고 사용자 대신 다른 조치를 수행할 수 있는 권한을 부여하는 데 사용할 개인 액세스 토큰을 입력해야 합니다. 개인 액세스 토큰이 없는 경우 GitHub 웹 사이트의 문서를 따라 토큰을 작성할 수 있습니다. 개인 액세스 토큰에
repo,delete_repo,read:user및workflow권한이 있는지 확인하십시오. -
GitHub 앱을 선택하면, IBM Cloud 은 OAuth 토큰 대신 GitHub 앱 설치를 사용하여 사용자를 대신해 GitHub 에 인증합니다. GitHub 앱은 더 세분화된 권한 제어 기능을 제공하며, 개별 사용자의 인증 정보에 의존하지 않습니다. 다음 방법 중 하나를 선택하십시오.
-
관리형 — IBM 에서 제공하는, 귀하의 GitHub 서버에 대해 미리 구성된 GitHub 앱을 사용하십시오. '승인'을 클릭하면 GitHub, 으로 이동하게 되며, 해당 페이지에서 앱의 계정 접근 권한을 승인할 수 있습니다.
-
사용자 지정 — 직접 준비한 ‘ GitHub ’ 앱을 가져오세요. 등록하고 설치한 xml-ph-0001@deepl.internal 앱의 App ID 저장소에 등록하고 설치한 GitHub 앱의 개인 키 ( PEM 형식)를 입력하십시오. 이 통합 기능과 함께 사용하려는 모든 저장소에 해당 앱을 설치해야 합니다. GitHub 앱 제작에 대한 자세한 내용은 GitHub 문서 을 참조하십시오.
-
-
-
GitHub Enterprise 서버에서 리포지토리를 직접 사용하고 있는 경우, 구성 가능한 통합 섹션에서 사용자 지정 서버를 클릭하십시오.
a. 사용자 지정 GitHub 서버의 제목을 입력하고, 서버의 URL 루트를 지정하며, 개인 액세스 토큰을 입력하세요.
b. 개인 액세스 토큰이 없는 경우 GitHub 웹 사이트의 문서를 따라 토큰을 작성할 수 있습니다.
c. GitHub 서버가 에어 갭이 있거나 공용 인터넷에서 액세스할 수 없는 경우, 자체 Delivery Pipeline 프라이빗 워커를 연결하고 통합하여 내부 또는 온프레미스 리소스에 액세스할 수 있는 Kubernetes 인프라에서 실행할 수 있습니다. Delivery Pipeline 개인 작업자에 대한 자세한 내용은 Delivery Pipeline 개인 작업자 로 작업하기를 참조하세요.
d. GitHub Enterprise 서버에 ‘ GitHub ’ 앱이 등록되어 있는 경우, ‘ GitHub ’ 앱 인증 방법을 선택하고 App ID 및 개인 키를 입력하거나, 서버에 미리 구성된 관리형 앱이 있다면 이를 사용할 수도 있습니다.
-
GitHub 저장소의 기본 대상 저장소 위치를 검토하십시오. 해당 저장소는 샘플 저장소에서 복제됩니다. 필요한 경우 대상 저장소의 이름을 변경하십시오.
도구 체인이 있고 여기에 이 도구 통합을 추가하는 경우 다음 단계를 따르십시오.
-
콘솔에서 IBM Cloud 메뉴 아이콘(
) > 플랫폼 자동화 > 툴체인스를 클릭합니다. 도구 체인 페이지에서 도구 체인을 클릭하여 해당 개요 페이지를 여십시오.
-
도구 추가를 클릭하십시오.
-
도구 통합 섹션에서 GitHub를 클릭하십시오.
-
사용할 GitHub 서버를 클릭하십시오.
-
GitHub 또는 GitHub Enterprise 저장소가 있으며 이를 사용하려면 저장소 유형에 대해 기존을 클릭하고 URL을 입력하십시오.
-
새 GitHub 또는 GitHub Enterprise 저장소를 사용하려는 경우, 해당 저장소의 이름을 입력하고 복제하거나 분기시킬 저장소의 URL을 입력하며 저장소 유형을 선택하십시오.
a. 빈 저장소를 작성하려면 새로 작성을 클릭하십시오.
b. GitHub 또는 GitHub Enterprise 저장소의 사본을 작성하려면 복제를 클릭하십시오.
c. 가져오기 요청을 통해 변경사항을 제공할 수 있도록 GitHub 또는 GitHub Enterprise 저장소를 분기하려면 분기를 클릭하십시오.
-
업그레이드된 계정이 있는 GitHub.com 사용자이거나 GitHub Enterprise 서버를 선택하고 서버에서 새 개인용 저장소를 작성하려는 경우 이 저장소를 개인용으로 설정 선택란을 선택하십시오.
-
문제 추적을 위해 GitHub의 Issues를 사용하려는 경우 GitHub Issues 사용 선택란을 선택하십시오.
-
커미트에 대한 태그 및 주석을 작성하여 코드 변경사항 배치를 추적하고 커미트에서 참조되는 문제에 대한 레이블 및 주석을 추적하려는 경우, 코드 변경사항 배치 추적 선택란을 선택하십시오.
-
통합 작성을 클릭하십시오.
-
도구 체인의 개요 페이지에 있는 저장소 카드에서, 작업할 GitHub 또는 GitHub Enterprise 저장소를 클릭하십시오. 선택한 저장소에 따라 저장소의 컨텐츠를 볼 수 있는 GitHub 웹 사이트 또는 회사의 GitHub Enterprise 저장소가 열립니다.
-
GitHub Issues를 사용한 경우에는 GitHub Issues를 클릭하여 이를 여십시오. 도구 체인에 여러 개의 GitHub 또는 GitHub Enterprise 저장소가 포함되어 있어도 전체 도구 체인에 대해 GitHub Issues의 이 인스턴스를 사용할 수 있습니다.
링크 중인 저장소에 대해 관리자 권한이 없으면 웹훅을 사용할 수 없으므로 통합이 제한됩니다. 웹훅은 커미트가 저장소에 푸시될 때 파이프라인을 자동으로 실행하는 데 필요합니다. 웹훅이 없으면 파이프라인을 수동으로 시작해야 합니다.
API를 사용하여 GitHub 구성하기
도구 GitHub 통합은 도구 통합을 생성, 읽기 및 업데이트할 때 Toolchain HTTP API 및 SDK와 함께 사용할 수 있는 다음 구성 매개변수를 지원합니다.
githubconsolidated 값을 사용하여 요청 본문에서 tool_type_id 특성을 지정해야 합니다.
| 매개변수 | 사용량 | 유형 | Terraform 인수 | 설명 |
|---|---|---|---|---|
| aPI_ROOT_URL | 선택적, 갱신 가능 | 문자열 | aPI_ROOT_URL | API URL 루트의 GitHub 서버에 대한. |
| api_token | 선택적, 갱신 가능 | 비밀번호 | api_token | 개인 액세스 토큰(PAT). 이 매개변수는 auth_type 가 pat 로 설정된 경우에만 필수이며, 그렇지 않으면 무시됩니다. |
| auth_type | 선택적, 갱신 가능 | 문자열 | auth_type | Git 제공자에 액세스할 때 사용할 인증 방법을 설정합니다. 유효한 값은 oauth, pat 및 github_app 입니다. github_app 가 지정되면, 인증 시 사용자 OAuth 토큰이나 PAT 대신 GitHub 앱 설치 토큰이 사용됩니다. |
| 자동 초기화 | 선택 사항, 변경 불가, Default: false |
부울 | 자동 초기화 | Readme 파일을 사용하여 이 저장소를 초기화하려면 이 값을 true 로 설정하십시오. 이 매개변수는 저장소를 작성하는 경우에만 사용됩니다. |
| 연결 설정 해제 | 선택 사항, 업데이트 가능, Default: false |
부울 | 연결 설정 해제 | 이 값을 true로 설정하면 공용 인터넷에서 서버를 주소 지정할 수 없습니다. IBM Cloud 은 사용자가 제공하는 연결 세부사항을 유효성 검증할 수 없습니다. git 서버에 대한 API 액세스가 필요한 특정 기능은 사용 안함으로 설정됩니다. 딜리버리 파이프라인은 git 서버에 대한 네트워크 액세스 권한이 있는 개인용 작업자만 사용하여 작동합니다. |
| 기본 분기 | 선택적, 갱신 가능 | 문자열 | 기본 분기 | Git 저장소의 기본 분기입니다. |
| enable_traceability | 선택 사항, 업데이트 가능, Default: false |
부울 | enable_traceability | 이 값을 로 설정하면 커밋, 풀 리퀘스트 및 참조된 이슈에 태그, 레이블 및 주석을 생성하여 코드 변경 사항의 배포 내역을 추적할 수 true 있습니다. |
| Git_ID | 선택적, 불변 | 문자열 | Git_ID | github.com의 경우 이 값을 github 로 설정하거나 사용자 정의 GitHub Enterprise 서버의 GUID로 설정하십시오. |
| github_app_auth_method | 선택적, 갱신 가능 | 문자열 | github_app_auth_method | auth_type 가 github_app 일 때 사용해야 하는 ‘ GitHub ’ 앱 인증 방식입니다. IBM 에서 제공하는 GitHub 앱을 사용하려면 ‘ managed ’로 설정하고(기본값), github_app_credential_app_id 및 github_app_credential_private_key 을 통해 직접 GitHub 앱 자격 증명을 제공하려면 ‘ custom ’로 설정하십시오. |
| github_app_credential_app_id | 선택적, 갱신 가능 | 문자열 | github_app_credential_app_id | 맞춤형 GitHub 앱을 위한 GitHub App ID. github_app_auth_method 가 custom 일 때 필요합니다. |
| github_app_credential_private_key | 선택적, 갱신 가능 | 비밀번호 | github_app_credential_private_key | 사용자 지정 GitHub 앱용 RSA 개인 키( PEM 형식). github_app_auth_method 가 custom 일 때 필요합니다. 키가 암호화된 상태로 저장됩니다. |
| has_issues | 선택 사항, 업데이트 가능, Default: true |
부울 | 툴체인_문제_활성화됨 | GitHub 저장소에서 문제를 사용으로 설정하고 도구 체인에 문제 도구 카드를 추가하려면 이 값을 true 로 설정하십시오. 도구 체인에서 도구 통합 카드를 제거하려면 값을 false 로 설정하십시오. 이 설정은 GitHub 저장소 자체에서 문제가 사용으로 설정되는지 여부에 영향을 주지 않습니다. |
| 통합 소유자 | 선택적, 갱신 가능 | 문자열 | 통합 소유자 | Git 조작이 수행되는 사용자를 선택하십시오. |
| owner_id | 선택적, 불변 | 문자열 | owner_id | 저장소를 소유하는 GitHub 사용자 또는 조직입니다. 이 매개변수는 저장소를 작성하거나 저장소를 복제 또는 분기할 때 필요합니다. 이 값은 기존 저장소에 링크할 때 계산됩니다. |
| 개인용 저장소 | 선택 사항, 변경 불가, Default: false |
부울 | 개인용 저장소 | 저장소를 작성하거나 복제하거나 포크할 때 저장소를 개인용으로 설정하려면 이 값을 true 로 설정하십시오. 이 매개변수는 기존 저장소에 링크할 때 사용되지 않습니다. |
| 저장소 ID | 선택적, 불변 | 문자열 | 저장소 ID | GitHub 저장소의 ID입니다. |
| repo_name | 선택적, 불변 | 문자열 | repo_name | 작성할 GitHub 저장소의 이름입니다. 이 매개변수는 저장소를 작성하거나 저장소를 복제 또는 분기할 때 필요합니다. 이 값은 기존 저장소에 링크할 때 계산됩니다. |
| repo_url | 선택적, 불변 | 문자열 | repo_url | 이 도구 통합에 대한 URLGitHub 리포지토리의 이 매개변수는 기존 저장소에 링크할 때 필요합니다. 이 값은 저장소를 작성하거나 저장소를 복제 또는 분기할 때 계산됩니다. |
| 루트 URL | 선택적, 갱신 가능 | 문자열 | 루트 URL | 서버의 URL 루트. 예: https://github.example.com |
| 소스 저장소 URL | 선택적, 불변 | 문자열 | 소스 저장소 URL | 포크하거나 복제하려는 저장소의 URL 이 매개변수는 저장소를 분기 실행하거나 복제할 때 필요합니다. 저장소를 작성하거나 기존 저장소에 링크하는 경우에는 사용되지 않습니다. |
| 제목 | 선택적, 갱신 가능 | 문자열 | 제목 | 서버의 제목입니다. 예: My GitHub Enterprise Server |
| 토큰 URL | 선택적, 갱신 가능 | 문자열 | 토큰 URL | 서버와의 GitHub 인증에 사용되는 토큰 URL. |
| 유형 | 필수, 불변 | 문자열 | 유형 | 새 도구 통합을 초기화하기 위해 수행할 조작입니다. new 를 사용하여 Git 저장소를 작성하거나, clone 기존 저장소를 새 Git 저장소에 복제하거나, fork 기존 Git 저장소를 분기하거나, link 를 사용하여 기존 Git 저장소에 링크하십시오. |
GitHub 앱 인증 사용
GitHub 앱 인증은 OAuth 및 개인 액세스 토큰(PAT) 방식의 대안입니다. GitHub 앱은 사용자가 아닌 애플리케이션 자체로 인증되므로, 더 세분화된 리포지토리 권한을 부여할 수 있고, 개별 사용자 계정 인증 정보에 의존할 필요가 없으며, 토큰이 자동으로 갱신되고 특정 리포지토리에만 적용됩니다.
다음과 같은 두 가지 모드가 제공됩니다:
- 관리형 (
github_app_auth_method: managed) - IBM Cloud IBM 에서 제공하는, 사용자의 서버에 미리 등록된 앱을 사용합니다. GitHub GitHub OAuth 동의 절차를 통해 앱에 권한을 부여하면, 그 결과 생성된 사용자-서버 토큰(
ghu_)이 자동으로 저장 및 사용됩니다. - 사용자 정의 (
github_app_auth_method: custom) - GitHub 또는 GitHub Enterprise 에서 직접 ‘ GitHub ’ 앱을 등록하고 관리할 수 있습니다. 사용자는 App ID 및 PEM 로 인코딩된 RSA 개인 키를 제공해야 합니다. IBM Cloud 는 이러한 인증 정보를 사용하여 유효 기간이 짧은 설치 액세스 토큰(
ghs_)을 자동으로 생성합니다. 이 통합 기능과 함께 사용하려는 모든 리포지토리에 ‘ GitHub ’ 앱을 설치해야 합니다.
GitHub 앱의 사용자 지정 인증을 시작하기 전에
GitHub 앱의 사용자 지정 인증을 구성하기 전에 다음 단계를 완료하십시오
-
GitHub 조직 또는 개인 계정에서 ‘ GitHub ’ 앱을 생성하세요. 앱에 최소한 다음 저장소 권한을 부여하십시오:
- 목차: 읽기 및 쓰기
- 메타데이터: 읽기 전용
- 풀 리퀘스트: 읽기 및 쓰기 (풀 리퀘스트 추적 기능을 사용하는 경우)
- 워크플로: 읽기 및 쓰기 (파이프라인이 ‘ GitHub ’ 액션을 트리거하는 경우)
-
앱용 개인 키를 생성하고
PEM파일을 저장하세요. 통합을 설정할 때 이 키가 필요합니다. -
툴체인이 액세스할 조직 또는 저장소에 ‘ GitHub ’ 앱을 설치하십시오. 자격 증명을 확인하려면 먼저 앱을 설치해야 합니다.
App ID 와 개인 키를 사용하여 도구 연동을 구성하면, IBM Cloud 은 GitHub API를 호출하여 자격 증명을 검증합니다. 지정된 저장소에 앱이 아직 설치되어 있지 않은 경우, 먼저 앱을 설치하라는 오류 메시지가 표시됩니다.