본문 바로가기
WIKI 기술 지식 베이스

GitHub Locations

원문 보기 위키 갱신

GitHub 통합은 github.com 또는 GitHub Enterprise에서 카탈로그 엔티티를 로드하는 것을 지원해요.

출처: 문서

본문

GitHub 통합은 github.com 또는 GitHub Enterprise에서 카탈로그 엔티티를 로드하는 것을 지원해요. 엔티티는 정적 카탈로그 구성에 추가하거나, catalog-import 플러그인으로 등록하거나, GitHub 조직에서 발견할 수 있어요. 사용자와 그룹도 조직에서 로드할 수 있어요.

구성

이 통합을 사용하려면 루트 app-config.yaml에 구성을 추가하세요.

integrations:  github:    - host: github.com      token: ${GITHUB_TOKEN}    - host: ghe.example.net      apiBaseUrl: https://ghe.example.net/api/v3      rawBaseUrl: https://ghe.example.net/raw      token: ${GHE_TOKEN}

note

편의를 위해 공개 GitHub 제공자는 시작 시 자동으로 추가됩니다. 따라서 토큰을 제공하고 싶을 때만 나열하면 됩니다.

github 키 바로 아래에는 데이터를 가져올 수 있는 다양한 GitHub 호환 제공자를 나열할 수 있는 제공자 구성 목록이 있어요. 각 항목은 최대 4개의 요소를 가진 구조예요.

  • host (선택): 일치시키려는 위치 대상의 호스트. 기본 호스트는 github.com이에요.

  • token (선택): GitHub가 기대하는 인증 토큰. 제공되면 이 제공자에 대한 API와 raw 호출 모두에 전달돼요. 제공되지 않으면 익명 접근이 사용돼요.

  • apiBaseUrl (선택): 이 제공자와 APIv3 방식으로 통신하고 싶다면, 후행 슬래시 없이 엔드포인트의 기본 URL을 여기에 지정하세요. 특히 대상이 GitHub라면 자동 추론되도록 생략할 수 있어요. GitHub Enterprise 설치에서는 보통 https://api.<host> 또는 https://<host>/api/v3에 있어요.

  • rawBaseUrl (선택): 이 제공자와 raw HTTP 방식으로 통신하고 싶다면, 후행 슬래시 없이 엔드포인트의 기본 URL을 여기에 지정하세요. 특히 대상이 공개 GitHub라면 자동 추론되도록 생략할 수 있어요. GitHub Enterprise 설치에서는 보통 https://<host>/raw에 있어요.

apiBaseUrl 또는 rawBaseUrl 중 하나 또는 둘 다를 제공해야 해요(공개 GitHub는 예외로 추론할 수 있어요). token이 주어지면 apiBaseUrl이 항상 다른 것보다 선호되고, 그렇지 않으면 rawBaseUrl이 선호돼요.

토큰 스코프

GitHub에서 개인용 액세스 토큰을 만들 때는 토큰의 접근 수준을 정의하는 스코프를 선택해야 해요. 필요한 스코프는 통합을 어떻게 사용하느냐에 따라 달라져요.

  • 소프트웨어 컴포넌트 읽기:

  • repo

  • 조직 데이터 읽기:

  • read:org

  • read:user

  • user:email

  • 소프트웨어 템플릿 게시:

  • repo

  • workflow(템플릿에 GitHub 워크플로가 포함된 경우)

GitHub Apps로 인증하기

또는 GitHub 조직의 경우, Backstage는 백엔드 인증에 GitHub Apps를 사용할 수 있어요. 이는 더 높은 요청 빈도 제한과 더 명확한 인증 모델을 제공해요. 설정 방법은 github-apps를 참고하세요.

더 알아보기 (Learn more)