설명서Commerce클라우드의 Commerce 안내서

[PaaS만]{class="badge informative" title="Adobe Commerce 온 클라우드 프로젝트(Adobe 관리 PaaS 인프라) 및 온프레미스 프로젝트에만 적용됩니다."}

GitHub 통합

Last update: Fri Jan 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • 관리자
  • 개발자

GitHub 통합을 사용하면 GitHub 저장소에서 직접 클라우드 인프라 환경의 Adobe Commerce을 관리할 수 있습니다. 통합은 GitHub에 이미 있는 콘텐츠를 관리하고 클라우드 인프라 코드 저장소의 Adobe Commerce과 동기화합니다. 본질적으로 코드 리포지토리는 GitHub 리포지토리의 미러가 됩니다.

NOTE
Adobe은 Adobe Commerce on cloud infrastructure 프로젝트에 개인 저장소를 사용하여 확장 및 중요한 구성과 같은 독점 정보 또는 개발 작업을 보호할 것을 강력히 권장합니다.

이 통합을 통해 다음과 같은 작업을 수행할 수 있습니다.

  • 분기 생성 시 환경 생성
  • 끌어오기 요청을 병합할 때 환경 재배포
  • 분기 삭제 시 환경 삭제

프로세스를 계속하려면 GitHub 토큰과 웹후크를 가져와야 합니다.

전제 조건

  • Adobe Commerce on cloud infrastructure 프로젝트에 대한 관리자 액세스
  • GitHub 저장소
  • GitHub 개인 액세스 토큰

GitHub 토큰 생성

GitHub 개발자 설정에서 클래식 개인 액세스 토큰을 만듭니다. 저장소에 푸시 ​할 수 있도록 GitHub 저장소에 대한 쓰기 권한이 있는 그룹의 구성원이어야 합니다. 토큰을 만들 때 다음 범위를 포함하십시오.

  • admin:repo_hook - 웹 후크 만들기
  • repo—리포지토리와 통합
  • read:org—조직 리포지토리와 통합

GitHub: 만들기를 참조하세요.

저장소 준비

기존 환경에서 Adobe Commerce on cloud infrastructure 프로젝트를 복제하고 프로젝트 분기를 새로운 빈 GitHub 저장소로 마이그레이션하여 동일한 분기 이름을 유지합니다. Adobe Commerce on cloud infrastructure 프로젝트에서 기존 환경 또는 분기를 잃지 않도록 동일한 Git 트리를 유지하는 것은 위험 ​입니다.

  1. 터미널에서 Adobe Commerce on cloud infrastructure 프로젝트에 로그인합니다.

    code language-bash 
    magento-cloud login

  2. 프로젝트 나열 및 프로젝트 ID 복사

    code language-bash 
    magento-cloud project:list

  3. 프로젝트를 로컬 환경에 복제합니다.

    code language-bash 
    magento-cloud project:get <project-ID>

  4. GitHub 저장소를 원격으로 추가합니다.

    code language-bash 
    git remote add origin git@github.com:<user-name>/<repo-name>.git

    원격 연결의 기본 이름은 origin 또는 magento일 수 있습니다. origin이(가) 있으면 다른 이름을 선택하거나 기존 참조의 이름을 바꾸거나 삭제할 수 있습니다. git-remote 설명서를 참조하세요.

  5. GitHub 원격을 올바르게 추가했는지 확인합니다.

    code language-bash 
    git remote -v

    예상 응답:

    code language-none 
    origin git@github.com:<user-name>/<repo-name>.git (fetch)
origin git@github.com:<user-name>/<repo-name>.git (push)

  6. 프로젝트 파일을 새 GitHub 리포지토리에 푸시합니다. 모든 분기 이름을 동일하게 유지하는 것을 잊지 마십시오.

    code language-bash 
    git push -u origin master

    새 GitHub 저장소로 시작하는 경우 원격 저장소가 로컬 복사본과 일치하지 않으므로 -f 옵션을 사용해야 할 수 있습니다.

  7. GitHub 저장소에 모든 프로젝트 파일이 포함되어 있는지 확인합니다.

GitHub 통합 활성화

시작하기 전에 프로젝트 코드와 환경은 GitHub 저장소에 있어야 합니다. 통합을 활성화하면 GitHub 저장소가 코드 소스가 됩니다. 코드 변경 내용을 원래 magento 리포지토리에 푸시하면 GitHub 리포지토리에 코드 변경 내용을 푸시할 때 통합에 의해 덮어쓰기됩니다.

다음은 GitHub 통합을 활성화하고 웹후크를 만들 때 사용할 페이로드 URL을 제공합니다.

WARNING
다음 명령은 production 분기를 포함하여 모든 분기를 포함하는 GitHub 저장소의 코드로 Adobe Commerce on cloud infrastructure 프로젝트의 all 코드를 덮어씁니다. 이 작업은 즉시 수행되며 실행 취소할 수 없습니다. Adobe Commerce on cloud infrastructure 프로젝트에서 모든 분기를 복제하여 GitHub 통합을 추가하기 전 ​에 GitHub 저장소로 푸시하는 것이 가장 좋습니다.

magento-cloud integration:add을(를) 사용하여 CLI 프롬프트를 단계별로 수행하도록 선택하거나 다음 옵션을 사용하여 통합 명령을 빌드할 수 있습니다.

옵션
필수?
설명
--base-url
예
서버 설치의 기본 URL입니다. https://github.com/ 또는 사용자 지정일 수 있습니다. 저장소가 공용 Github로 호스팅되거나 저장소가 개인 서버에서 호스팅되지 않는 경우 이 옵션을 생략합니다. 저장소 URL이 https://github.com/{account}/{repository-name}과(와) 유사한 경우 이 옵션을 생략합니다. 이로 인해 Unable to connect to GitHub: repository not found과(와) 같은 오류가 발생할 수 있습니다.
--token
예
GitHub에 대해 생성한 개인 액세스 토큰
--repository
예
저장소 이름: owner-or-organisation/repository
--build-pull-requests
선택 사항
끌어오기 요청을 병합한 후 배포하도록 클라우드 인프라의 Adobe Commerce에 지시합니다(기본적으로 true).
--fetch-branches
선택 사항
분기(true(기본적으로)를 업데이트한 후 클라우드 인프라의 Adobe Commerce에서 분기를 추적하고 배포하도록 합니다.
--prune-branches
선택 사항
원격(기본적으로 true)에 없는 분기를 삭제합니다.

많은 옵션이 있으며 도움말 옵션을 사용하여 볼 수 있습니다.

magento-cloud integration:add --help

GitHub 통합을 사용하려면:

  1. 통합을 활성화합니다.

    code language-bash 
    magento-cloud integration:add --type=github --project=<project-ID> --token=<your-GitHub-token> {--repository=USER/REPOSITORY | --repository=ORGANIZATION/REPOSITORY} [--build-pull-requests={true|false} --fetch-branches={true|false}

    예 1: 개인 개인 리포지토리에 대해 GitHub 통합을 사용하도록 설정합니다.

    code language-bash 
    magento-cloud integration:add --type=github --project=ov58dlacU2e --base-url=https://github.com --token=<token> --repository=myUserName/myrepo

    예 2: 조직 리포지토리에 대해 GitHub 통합을 사용하도록 설정합니다.

    code language-bash 
    magento-cloud integration:add --type=github --project=ov58dlacU2e --base-url=https://github.com --token=<token> --repository=Magento/teamrepo

  2. 메시지가 표시되면 필요한 정보를 입력합니다.

  3. 반환 출력에서 표시되는 페이로드 URL ​을(를) 복사합니다.

    code language-none 
    Created integration <integration-ID> (type: github)
Repository: myUserName/myrepo
Build PRs: yes
Fetch branches: yes
Payload URL: https://us.magento.cloud/api/projects/<project-id>/integrations/wO8a0eoamxwcg/hook

GitHub에서 Webhook 추가

Cloud Git 서버와 푸시 등의 이벤트를 전달하려면 GitHub 저장소에 대한 웹후크를 만들어야 합니다.

  1. GitHub 리포지토리에서 설정 탭을 클릭합니다.

  2. 왼쪽 탐색 모음에서 웹후크 ​를 클릭합니다.

  3. Webhooks 창에서 Webhook 추가 ​를 클릭합니다.

  4. Webhooks/Add webhook 양식에서 다음 필드를 편집합니다.

    • 페이로드 URL: GitHub 통합을 사용하도록 설정할 때 반환된 URL을 입력합니다.
    • 콘텐츠 형식: 목록에서 application/json ​을(를) 선택하십시오.
    • 암호: 확인 암호를 입력하십시오.
    • 이 웹후크를 트리거할 이벤트를 선택하십시오.: 모두 보내기 ​를 선택합니다.
    • 활성 확인란을 선택하십시오.

  5. Webhook 추가 ​를 클릭합니다.

통합 테스트

GitHub 통합을 구성한 후 magento-cloud CLI를 사용하여 통합이 작동하는지 확인할 수 있습니다.

magento-cloud integration:validate

또는 간단한 변경 사항을 GitHub 저장소에 푸시하여 테스트할 수 있습니다.

  1. 테스트 파일을 만듭니다.

    code language-bash 
    touch test.md

  2. 변경 사항을 커밋하고 GitHub 저장소에 푸시합니다.

    code language-bash 
    git add . && git commit -m "Testing GitHub integration" && git push

  3. Cloud Console에 로그인하고 커밋 메시지가 표시되고 프로젝트가 배포되는지 확인합니다.

통합 제거

코드에 영향을 주지 않고 프로젝트에서 GitHub 통합을 안전하게 제거할 수 있습니다.

GitHub 통합을 제거하려면:

  1. 터미널에서 Adobe Commerce on cloud infrastructure 프로젝트에 로그인합니다.

  2. 통합을 나열합니다. 다음 단계를 완료하려면 GitHub 통합 ID가 필요합니다.

    code language-bash 
    magento-cloud integration:list

  3. 통합을 삭제합니다.

    code language-bash 
    magento-cloud integration:delete <int-ID>

또한 GitHub 계정에 로그인하고 저장소 설정 ​의 Webhooks 탭에서 웹 후크를 제거하여 GitHub 통합을 제거할 수 있습니다.

recommendation-more-help
7c2b03ac-000c-497d-aba3-2c6dc720a938