사용자 정의 PR 템플릿 적용

API를 사용하여 사용자 정의 PR 템플릿 생성 및 관리

API 엔드포인트인 그룹을 위한 풀 리퀘스트 템플릿 생성 또는 업데이트를 사용하여 사용자 정의 PR 템플릿을 생성할 수 있습니다. 사용자 정의 속성이 포함된 JSON 페이로드를 API 요청으로 보내십시오. 이 요청은 해당 그룹 내의 모든 조직 또는 프로젝트에서 사용할 그룹 수준의 풀 리퀘스트 템플릿을 구성합니다. Snyk API를 사용하여 생성된 풀 리퀘스트 템플릿은 언제든지 업데이트할 수 있으며, 그룹 내의 모든 프로젝트가 최신 변경 사항으로 자동으로 업데이트됩니다.

PR 템플릿의 API 구성은 그룹 수준에서만 가능합니다.

API 요청을 통해 사용자 정의 템플릿이 업로드되면, 해당 그룹의 모든 Snyk PR은 이 형식을 채택하며 사용자 정의 가능한 속성에 대해 기본 Snyk 템플릿을 사용하지 않게 됩니다. 문자열(String)만 허용되는 값이며, 리스트(List)나 숫자(Number)는 허용되지 않습니다.

사용자 정의 템플릿에 사용자 정의 가능한 속성 중 일부가 누락된 경우, Snyk은 풀 리퀘스트를 열 때 해당 속성에 대해 기본값을 사용합니다.

API를 사용하여 다음 속성들을 사용자 정의할 수 있습니다.

• title - PR 제목 사용자 정의

• commit_message - PR 커밋 메시지 사용자 정의

• description - PR 설명 사용자 정의

PR의 브랜치 이름은 사용자 정의할 수 없습니다. PR의 브랜치 이름에는 Snyk 기본값이 사용됩니다.

그룹을 위한 풀 리퀘스트 템플릿 가져오기 엔드포인트를 사용하여 그룹의 사용자 정의 PR 템플릿을 조회할 수 있습니다. 이는 템플릿 변경을 고려하거나 문제 해결 시 유용합니다.

템플릿을 삭제하려면 그룹을 위한 풀 리퀘스트 템플릿 삭제 엔드포인트를 사용하십시오.

YAML PR 템플릿 파일을 사용하여 사용자 정의

YAML 파일 생성

템플릿 작성을 위해 mustache 구문을 사용하여 수동으로 YAML 템플릿을 생성하고 해당 파일을 프로젝트 또는 리포지토리에 추가하십시오.

사용자 정의 템플릿이 프로젝트에 업로드되면, 해당 프로젝트에 대한 Snyk의 모든 PR은 이 형식을 채택하며 사용자 정의된 속성에 대해 기본 Snyk 템플릿을 사용하지 않게 됩니다. 문자열만 허용되는 값이며, 리스트나 숫자는 허용되지 않습니다. 템플릿에 사용자 정의 가능한 속성 중 일부가 누락된 경우, Snyk은 풀 리퀘스트를 열 때 해당 속성에 대해 기본값을 사용합니다.

YAML 다중행 연산자 (YAML multiline operators)

YAML 다중행 연산자를 사용할 수 있습니다. 다음 형식을 따라 여러 줄에 걸친 상세한 설명을 작성할 수 있습니다.

description: |
  이 풀 리퀘스트는 Snyk에서 생성되었습니다.
  더 자세한 정보는 프로젝트 페이지 {{ snyk_project_url }} 를 참조하십시오.
  추가 질문이 있는 경우 보안 팀 멤버에게 문의하십시오.

파이프 연산자(|)는 줄 바꿈 문자를 유지합니다. 꺾쇠괄호(>)를 사용하면 모든 줄을 공백으로 연결하고 마지막에 줄 바꿈을 하나 추가합니다. 콜론(:)을 사용하려면 다중행 연산자(| 또는 >)를 사용하거나 해당 행을 큰따옴표로 묶어야 합니다.

commitMessage: "snyk: 이것은 보안 관련 풀 리퀘스트입니다"

YAML에서 사용자 정의 가능한 속성

다음 속성들을 사용자 정의할 수 있습니다.

• title - PR 제목 사용자 정의

• commitMessage - PR 커밋 메시지 사용자 정의

• description - PR 설명 사용자 정의

PR의 브랜치 이름은 사용자 정의할 수 없습니다. PR의 브랜치 이름에는 Snyk 기본값이 사용됩니다.

YAML 사용자 정의 PR 템플릿 사용

YAML 파일을 snyk_pull_request_template.yaml이라는 이름으로 프로젝트(리포지토리)에 수동으로 업로드할 수 있습니다. 경로는 통합 유형에 따라 다릅니다.

• GitHub/ GitHub Enterprise - /.github/snyk_pull_request_template.yaml

• GitLab - /.gitlab/snyk_pull_request_template.yaml

• Azure DevOps - /.azuredevops/snyk_pull_request_template.yaml

• 기타 (예: BitBucket) - /.config/snyk_pull_request_template.yaml

여러 리포지토리에 대해 사용자 정의 템플릿을 사용하려면 각 리포지토리에 YAML 사용자 정의 템플릿 파일을 추가하십시오.

사용자 정의 PR 템플릿 가져오기를 위한 Broker 구성

Snyk Broker를 사용하는 경우, Broker 버전이 4.188.0 이상이어야 하며 ACCEPT_CUSTOM_PR_TEMPLATES 환경 변수를 사용하여 Broker가 사용자 정의 PR 템플릿을 가져올 수 있도록 설정해야 합니다.

이를 위해 ACCEPT=/path/to/custom.json을 제거하고 Broker 컨테이너 또는 배포 환경에 다음 환경 변수를 추가해야 합니다.

ACCEPT_CUSTOM_PR_TEMPLATES=true