VS Code용 Cloud Code에서 커스텀 샘플 저장소 관리

샘플 저장소는 개발자가 애플리케이션을 개발할 때 사용할 수 있도록 생성한 커스텀 샘플이 포함된 Git 저장소입니다.

즉, 조직 또는 팀 내에서 조직에 맞게 Cloud Code로 샘플 저장소를 설정하여 다른 사람이 사용할 수 있는 시작 애플리케이션, 서비스, 인프라 구성을 제공할 수 있습니다. 이렇게 하면 새로운 프로젝트를 조직이 선호하는 기술 스택 및 표준에 맞추는 데 도움이 되며 개발 주기 초기에 권장사항을 장려할 수 있습니다.

샘플 저장소는 이전에 만든 샘플 애플리케이션의 기존 저장소이거나 다른 사람이 사용할 수 있는 새로운 샘플 세트일 수 있습니다. Cloud Code를 사용하여 저장소를 가져오려면 저장소에 샘플 설명자 파일을 추가하세요.

준비가 되면 샘플 저장소를 팀과 간편하게 공유할 수 있습니다. Cloud Code를 설정하고 사용할 샘플 저장소의 Git URL이 있어야 합니다. 비공개 Git 저장소의 경우 저장소에 대한 액세스 권한이 있는 구성원만 기본 커스텀 샘플을 사용할 수 있습니다.

샘플 저장소를 설정하는 방법의 예시를 보려면 이 저장소를 참조하세요.

시작하기 전에

Git 버전 2.25.0 이상이 로컬 머신에 설치되어 있어야 합니다.

샘플 저장소 만들기

기존 저장소를 사용하려면 샘플 설명자 파일 만들기로 건너뛰세요. 샘플 저장소로 사용할 새 저장소를 만들려면 다음 단계를 따르세요.

  1. 새 Git 저장소를 만듭니다.

    Git 저장소는 로컬 머신에 원격으로 또는 라이브로 호스팅될 수 있습니다. 이 예시에서는 새 GitHub 저장소인 'custom-sample-repo'를 사용합니다.

    'custom-sample-repo'로 채워진 저장소 이름 필드가 있는 GitHub 저장소 생성 인터페이스

  2. 저장소에 샘플 디렉터리를 추가합니다.

    샘플 디렉터리에는 모든 항목이 포함될 수 있으며 저장소 내 원하는 곳 어디에든 위치할 수 있습니다. 이 예시에서는 샘플 디렉터리 'hello-world' 및 'kubernetes-custom-sample' 두 개가 'custom-sample-repo'에 추가되었습니다.

    커스텀 샘플 사용 방법에 대한 안내가 포함된 readme 파일이 권장됩니다.

    'hello-world' 및 'kubernetes-custom-sample'이라는 두 가지 기본 샘플 디렉터리가 있는 'custom-sample-repo'

  3. 샘플 설명자 파일을 만듭니다.

    샘플 설명자 파일은 애플리케이션을 올바르게 만들기 위해 샘플에 대한 정보를 Cloud Code에 제공합니다. 이 파일의 이름은 루트 디렉터리에 있는 .cctemplate이어야 하며 샘플 설명어 파일 스키마 섹션에 정의된 스키마가 있어야 합니다.

  4. 커스텀 샘플에서 앱 생성 단계에 따라 커스텀 샘플을 테스트합니다.

샘플 설명자 스키마

설명 유형
메타데이터 Cloud Code에서 읽기에 사용되는 메타데이터입니다. 메타데이터 스키마를 준수합니다. 메타데이터
템플릿 저장소에 포함된 샘플의 배열입니다. 이 배열의 객체는 샘플 스키마를 준수해야 합니다. 배열<Sample>
이름(선택사항) 샘플 저장소 이름입니다. 문자열

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

샘플 스키마

설명 유형
경로 저장소에서 샘플의 위치입니다.
경로는 저장소의 루트를 기준으로 합니다.
문자열
이름 샘플 이름
애플리케이션 기반이 될 샘플을 선택할 때 IDE에 이름이 표시됩니다.
문자열
설명(선택사항) 샘플 설명입니다.
애플리케이션의 기반이 될 샘플을 선택할 때 설명이 IDE에 표시됩니다.
문자열

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

메타데이터 스키마

설명 유형
버전 사용할 샘플 스키마의 버전입니다. 유일하게 유효한 버전은 1입니다. 문자열

{
   "version":"1"
}

커스텀 샘플 저장소 삭제

커스텀 애플리케이션 선택기 흐름과 사용자 머신에서 삭제하는 커스텀 샘플을 삭제하려면 다음 안내를 따르세요.

  1. settings.json 파일에서 localPath를 확인하여 커스텀 샘플 항목을 찾습니다.

    "cloudcode.customApplications": [
      {
        "repoUrl": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,
        "branchName": "",
        "localPath": "/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git"
      }
    ],
    
  2. 경로에서 템플릿 폴더를 삭제합니다.

  3. settings.json 파일에서 커스텀 샘플 섹션을 삭제합니다.

지원받기

의견을 보내려면 GitHub에서 문제를 보고하거나 Stack Overflow에서 질문하세요.