배포 환경 관리

배포 보호 규칙을 사용하여 환경을 만들고 해당 환경을 보호할 수 있습니다. 환경을 참조하는 작업은 환경에 대한 모든 보호 규칙을 따라야 환경의 비밀을 실행하거나 액세스할 수 있습니다.

누가 이 기능을 사용할 수 있나요?

Repository owners

Environments, environment secrets, and deployment protection rules are available in public repositories for all current GitHub plans. They are not available on legacy plans, such as Bronze, Silver, or Gold. For access to environments, environment secrets, and deployment branches in private or internal repositories, you must use GitHub Pro, GitHub Team, or GitHub Enterprise.

이 문서의 내용

필수 조건

환경 만들기

개인 계정 리포지토리에서 환경을 구성하려면 리포지토리 소유자여야 합니다. 조직 리포지토리에서 환경을 구성하려면 admin 액세스 권한이 있어야 합니다.

  1. GitHub에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리 이름 아래에서 설정을 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.

    탭을 보여 주는 리포지토리 헤더의 스크린샷. "설정" 탭이 진한 주황색 윤곽선으로 강조 표시됩니다.

  3. 왼쪽 사이드바에서 환경을 클릭합니다.

  4. 새 환경을 클릭합니다.

  5. 환경의 이름을 입력한 다음 환경 구성을 클릭합니다. 환경 이름은 대/소문자를 구분하지 않습니다. 환경 이름은 255자를 초과하지 않아야 하며 리포지토리 내에서 고유해야 합니다.

  6. 필요에 따라 이 환경을 사용하는 워크플로 작업을 승인해야 하는 사용자 또는 팀을 지정합니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 필수 검토자를 선택합니다.
    2. 최대 6명 또는 팀을 입력합니다. 작업을 계속하려면 필수 검토자 중 한 명만 작업을 승인하면 됩니다.
    3. 필요에 따라 사용자가 트리거한 워크플로 실행을 승인하지 못하도록 하려면 자체 검토 방지를 선택합니다.
    4. 보호 규칙 저장을 클릭합니다.

  7. 필요에 따라 이 환경을 사용하는 워크플로 작업을 계속 진행하도록 허용하기 전에 대기할 시간을 지정합니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 대기 타이머를 선택합니다.
    2. 대기할 시간(분)을 입력합니다.
    3. 보호 규칙 저장을 클릭합니다.

  8. 필요에 따라 구성된 보호 규칙을 바이패스할 수 없습니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 관리자가 구성된 보호 규칙을 무시하도록 허용을 선택 취소합니다.
    2. 보호 규칙 저장을 클릭합니다.

  9. 필요에 따라 GitHub Apps을(를) 사용하여 만든 사용자 지정 배포 보호 규칙을 사용하도록 설정합니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 사용하도록 설정할 사용자 지정 보호 규칙을 선택합니다.
    2. 보호 규칙 저장을 클릭합니다.

  10. 필요에 따라 이 환경에 배포할 수 있는 분기 및 태그를 지정합니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 배포 분기 드롭다운에서 원하는 옵션을 선택합니다.

    2. Selected branches and tags를 선택하여 새 규칙을 추가하려면 Add deployment branch or tag rule를 클릭합니다.

    3. 적용할 규칙에 따라 "Ref type" 드롭다운 메뉴에서 Branch 또는 Tag를 클릭합니다.

    4. 허용하려는 분기 또는 태그의 이름 패턴을 입력합니다.

      참고 항목

      이름 패턴은 분기나 태그에 대해 개별적으로 구성해야 합니다.

    5. 규칙 추가를 클릭합니다.

  11. 필요에 따라 환경 비밀을 추가합니다. 해당 비밀은 환경을 사용하는 워크플로 작업에서만 사용할 수 있습니다. 또한 이 환경을 사용하는 워크플로 작업은 구성된 규칙(예: 필수 검토자)이 통과한 후에만 해당 비밀에 액세스할 수 있습니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 환경 비밀에서 비밀 추가를 클릭합니다.
    2. 비밀 이름을 입력합니다.
    3. 비밀 값을 입력합니다.
    4. 비밀 추가를 클릭합니다.

  12. 필요에 따라 환경 변수를 추가합니다. 이러한 변수는 환경을 사용하는 워크플로 작업에서만 사용할 수 있으며 vars 컨텍스트를 통해서만 액세스할 수 있습니다. 자세한 내용은 배포 및 환경을(를) 참조하세요.

    1. 환경 변수에서** 변수 추가**를 클릭합니다.
    2. 변수 이름을 입력합니다.
    3. 변수 값을 입력합니다.
    4. 변수 추가를 클릭합니다.

REST API를 통해 환경을 만들고 구성할 수도 있습니다. 자세한 내용은 Deployment Environments에 대한 REST API 엔드포인트, GitHub Actions 비밀에 대한 REST API 엔드포인트, GitHub Actions 변수에 대한 REST API 엔드포인트, 배포 분기 정책에 대한 REST API 엔드포인트을(를) 참조하세요.

존재하지 않는 환경을 참조하는 워크플로를 실행하면 참조된 이름을 가진 환경이 생성됩니다. 암시적 페이지 빌드를 실행하여 환경을 만드는 경우(예: 분기 또는 폴더 원본에서) 원본 분기가 환경에 보호 규칙으로 추가됩니다. 그렇지 않으면 새로 만든 환경에는 보호 규칙이나 비밀이 구성되지 않습니다. 리포지토리에서 워크플로를 편집할 수 있는 사람은 누구나 워크플로 파일을 통해 환경을 만들 수 있지만 리포지토리 관리자만 환경을 구성할 수 있습니다.

환경 삭제

개인 계정 리포지토리에서 환경을 구성하려면 리포지토리 소유자여야 합니다. 조직 리포지토리에서 환경을 구성하려면 admin 액세스 권한이 있어야 합니다.

환경을 삭제하면 환경과 연결된 모든 비밀 및 보호 규칙이 삭제됩니다. 삭제된 환경의 보호 규칙으로 인해 현재 대기 중인 모든 작업은 자동으로 실패합니다.

  1. GitHub에서 리포지토리의 기본 페이지로 이동합니다.

  2. 리포지토리 이름 아래에서 설정을 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.

    탭을 보여 주는 리포지토리 헤더의 스크린샷. "설정" 탭이 진한 주황색 윤곽선으로 강조 표시됩니다.

  3. 왼쪽 사이드바에서 환경을 클릭합니다.

  4. 삭제하려는 환경 옆에 있는 을(를) 클릭합니다.

  5. 이해했습니다. 이 환경을 삭제합니다를 클릭합니다.

REST API를 통해 환경을 삭제할 수도 있습니다. 자세한 내용은 리포지토리에 대한 REST API 엔드포인트을(를) 참조하세요.

환경과 배포 간의 관계

환경을 참조하는 워크플로 작업이 실행되면 환경 이름으로 설정된 environment 속성이 있는 배포 개체를 만듭니다. 워크플로가 진행됨에 따라 환경 이름으로 설정된 environment 속성, 환경의 URL로 설정된 environment_url 속성(워크플로에 지정된 경우), 작업의 상태로 설정된 state 속성이 있는 배포 상태 개체도 만듭니다.

REST API 또는 GraphQL API를 통해 해당 개체에 액세스할 수 있습니다. 해당 웹후크 이벤트를 구독할 수도 있습니다. 자세한 내용은 리포지토리에 대한 REST API 엔드포인트, 개체(GraphQL API), 웹후크 이벤트 및 페이로드을(를) 참조하세요.

다음 단계

GitHub Actions은(는) 배포를 관리하기 위한 몇 가지 기능을 제공합니다. 자세한 내용은 GitHub Actions를 사용하여 배포을(를) 참조하세요.