Skip to main content

리포지토리에 권장되는 비밀 지정

사용자가 codespace를 만들 때 특정 비밀을 설정하라는 메시지를 표시하는 설정을 개발 컨테이너 구성에 추가할 수 있습니다.

이 기능을 사용할 수 있는 사람

People with write permissions to a repository can create or edit the codespace configuration.

프로젝트에 사용자별 비밀을 설정해야 하는 경우 codespace를 만들 때 사용자에게 이 작업을 수행하라는 메시지를 표시할 수 있습니다. 리포지토리에 대한 개발 컨테이너 구성 파일에 설정을 추가하여 이 작업을 수행합니다.

권장 비밀을 지정한 후 사용자가 Codespaces에 대한 개인 설정에서 해당 비밀을 아직 만들지 않은 경우 codespace를 만드는 고급 옵션 방법을 사용할 때 해당 비밀을 만들라는 메시지가 표시됩니다. 코드 단추를 클릭한 다음 Codespaces 탭을 클릭한 다음 을(를) 선택하고 옵션으로 새로 만들기를 클릭하여 GitHub.com됩니다.

"Codespaces" 탭의 옵션 드롭다운에서 "옵션으로 새로 만들기" 옵션이 강조 표시된 스크린샷

권장 비밀은 페이지 맨 아래에 나열됩니다.

Screenshot of the "Create codespace" page with four recommended secrets highlighted with a dark orange outline.

참고: 권장되는 비밀의 이름은 선택한 분기의 컨테이너 구성에서 이러한 비밀을 지정하는 경우에만 이 페이지에 나열됩니다.

각 권장 비밀은 다음 세 가지 방법 중 하나로 표시됩니다.

  • 사용자가 Codespaces 설정에서 권장 비밀을 설정하지 않은 경우 입력 상자가 표시되어 이제 비밀을 만들 수 있습니다. 구성한 경우 추가 정보에 대한 설명과 링크가 표시됩니다. 값을 입력하는 것은 선택 사항입니다.
  • 권장 암호를 이미 만들었지만 이 리포지토리와 연결하지 않은 경우 확인 상자를 선택하여 이 연결을 추가할 수 있습니다. 이는 선택 사항입니다.
  • 사용자가 이미 권장 비밀을 만들고 이 리포지토리와 연결한 경우 미리 선택된 확인 상자가 표시됩니다.

리포지토리 또는 조직의 소유자가 아닌 codespace를 만드는 사용자가 제공해야 하는 비밀에 권장되는 비밀을 사용해야 합니다. 예를 들어 퍼블릭 프로젝트가 있고 사용자가 프로젝트에서 애플리케이션을 실행하기 위해 개인 API 키를 제공해야 하는 경우 사용자가 고급 옵션 페이지를 사용하여 codespace를 만들 때 키를 비밀 값으로 제공하라는 메시지가 표시되도록 권장 비밀을 지정할 수 있습니다.

또는 리포지토리 또는 조직의 소유자가 제공할 수 있는 비밀(예: 팀 간에 공유되는 API 키)의 경우 리포지토리 또는 조직의 수준에서 비밀을 설정할 수 있습니다. 자세한 정보는 "Github Codespaces의 리포지토리 및 조직에 대한 비밀 관리"을(를) 참조하세요.

  1. devcontainer.json 파일에 설정을 추가하여 리포지토리에 대해 만들어진 codespace를 구성할 수 있습니다. 리포지토리에 아직 devcontainer.json 파일이 없으면 지금 추가할 수 있습니다. "리포지토리에 개발 컨테이너 구성 추가"을(를) 참조하세요.

  2. 바깥쪽 JSON 개체 내에서 파일의 최상위 수준에 secrets 속성을 추가하여 devcontainer.json 파일을 편집합니다. 예시:

    JSON
    "secrets": {
      "NAME_OF_SECRET_1": {
        "description": "This is the description of the secret.",
        "documentationUrl": "https://example.com/link/to/info"
      },
      "NAME_OF_SECRET_2": { }
    }
    
  3. 추천할 각 비밀에 대한 secrets 이내의 속성을 추가합니다. 예를 들어 이전 코드 예제에서 Codespaces에 대한 개인 설정에서 사용자가 만들어야 하는 비밀의 이름에 대해 NAME_OF_SECRET_1NAME_OF_SECRET_2를 변경합니다.

  4. 필요에 따라 각 비밀에 대한 설명과 이 비밀에 대한 자세한 내용은 URL을 제공합니다.

    이전 코드 예제와 같이 NAME_OF_SECRET_2를 통해 descriptiondocumentationUrl를 생략 하고 생략할 수 있습니다.

  5. 필요에 따라 추가 비밀을 지정합니다.

  6. 파일을 저장하고 리포지토리의 필요한 분기에 변경 내용을 커밋합니다.

추가 참고 자료