GitHub 앱의 코드 작성 정보

GitHub App에 기능을 추가하는 코드를 작성해야 합니다.

이 문서의 내용

필수 조건

GitHub App의 코드를 작성하려면 GitHub App을 등록해야 합니다. GitHub App을 설정할 때 앱에 대한 특정 권한을 선택합니다. 이러한 권한은 GitHub App이(가) 수행할 수 있는 작업을 결정합니다. 앱을 등록할 때는 GitHub App이(가) 수신해야 하는 웹후크 이벤트를 비롯하여 다른 설정도 지정합니다. 언제든지 GitHub App 등록의 설정을 변경할 수 있습니다. 자세한 내용은 "GitHub 앱 등록" 및 "GitHub 앱 등록 수정"을(를) 참조하세요.

GitHub App이(가) 리포지토리 및/또는 조직 데이터에 액세스하도록 하려면 GitHub App을(를) 설치해야 합니다. 자세한 내용은 "자신만의 GitHub 앱 설치"을(를) 참조하세요.

GitHub App의 코드 작성

GitHub App이(가) 작업을 수행하려면 GitHub App에 기능을 추가하는 코드를 작성해야 합니다.

GitHub App의 코드를 작성하는 방법에 대한 자습서는 다음을 참조하세요.

GitHub App 등록의 자격 증명을 사용하여 GitHub의 API에 대한 인증된 요청을 수행할 수 있습니다. 자세한 내용은 "GitHub 앱을 사용한 인증 정보"을(를) 참조하세요.

개발하는 동안 개인용 컴퓨터 또는 codespace를 사용하여 GitHub App을(를) 실행할 수 있습니다. 개발 중에 GitHub App 등록을 일부 수정해야 할 수 있습니다.

  • 앱이 웹후크를 수신하는 경우 웹후크 프록시 URL을 사용하여 웹후크를 GitHub에서 컴퓨터 또는 codespace로 전달할 수 있습니다. 웹후크 프록시 URL을 사용하도록 GitHub App 등록에서 "웹후크 URL" 설정을 업데이트해야 합니다. 예는 "웹후크 이벤트에 응답하는 GitHub 앱 빌드"을(를) 참조하세요.

  • 앱이 웹 애플리케이션 흐름을 사용하여 사용자에게 권한을 부여하는 경우 로컬 콜백 URL을 사용하도록 GitHub App 등록에서 "콜백 URL" 설정을 업데이트할 수 있습니다. 예는 "GitHub 앱을 사용하여 "GitHub로 로그인" 단추 빌드"을(를) 참조하세요.

다음 단계

GitHub App의 코드를 작성하고 나면, 코드가 모범 사례를 따르는지 확인해야 합니다. 필요한 경우 GitHub App 등록을 업데이트해야 합니다. GitHub App이(가) 사용자의 디바이스 대신 서버에서 실행되어야 하는 경우 서버에 앱을 배포합니다. 마지막으로, 다른 사용자 및 조직과 GitHub App을(를) 공유할 수 있습니다.

모범 사례 준수

GitHub App을(를) 배포하기 전에 모범 사례를 따르는지 확인해야 합니다. 예를 들어 GitHub App의 자격 증명이 안전한지 확인합니다. 자세한 내용은 "GitHub App을 만드는 모범 사례"을(를) 참조하세요.

GitHub App 등록 업데이트

개발을 위해 GitHub App 등록을 변경한 경우 프로덕션 환경에 사용 가능한 값을 사용하도록 등록을 업데이트해야 합니다. 예를 들어 개발에 웹후크 프록시 URL을 사용한 경우 "웹후크 URL" 필드를 업데이트하여 프로덕션 중에 GitHub App이(가) 웹후크를 수신하도록 할 URL을 사용해야 합니다.

GitHub App 배포

GitHub App에 대한 코드를 작성했으면 코드가 어딘가에서 실행되어야 합니다. 앱이 웹 사이트 또는 웹앱인 경우 Azure App Service와 같은 서버에서 앱을 호스트할 수 있습니다. 앱이 클라이언트 쪽 앱인 경우 사용자의 디바이스에서 실행될 수 있습니다.

GitHub App 공유

GitHub App을(를) 다른 사용자 및 조직과 공유하려면 GitHub App을(를) 공개로 설정해야 합니다. GitHub App을(를) 쉽게 검색할 수 있도록 하려면 GitHub Marketplace에 리스팅하면 됩니다. 자세한 내용은 "GitHub 앱 공유"을 참조하세요.