예시 및 템플릿 검증

사용자 정의 PR 템플릿 예시

다음 예시 템플릿들은 PR 템플릿에서 변수를 사용하는 방법을 보여줍니다.

API 사용자 정의 PR 템플릿 예시

{
    "data": {
        "attributes": {
            "title": "[{{ snyk_pull_request_type }}] {{ package_name }}에 대한 수정",
            "commit_message": "{{ snyk_pull_request_type}}: {{ package_name }}에 대한 수정",
            "description": "패키지 {{ package_name }}을 {{ package_from }}에서 {{ package_to }}로 변경합니다.
{{ issue_count }}개의 이슈를 해결합니다.
자세한 정보는 {{ snyk_project_url }}을 참조하십시오.
프로젝트: {{ snyk_project_name }}
조직: {{ snyk_org_name }}"
        },
        "type": "pull_request_template"
    }
}

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

title: 이 PR은 {{ issue_count }}개의 이슈를 해결합니다
commitMessage: "fix: {{ issue_count }}개의 Snyk 이슈 해결"
description: |
  {{ #is_upgrade_pr }}
  이 PR은 리포지토리를 최신 상태로 유지하기 위해 열렸습니다.
  {{ package_name }} 패키지를 {{ package_from }} 버전에서 {{ package_to }} 버전으로 업데이트합니다.
  가능한 파괴적 변경 사항(breaking changes)에 대해 관련 문서를 검토하십시오.
  {{ /is_upgrade_pr }}
  
  **티켓**
  {{ #jira_ids }}
  - 수정 사항: {{ . }}
  {{ /jira_ids }}
  
  더 자세한 내용은 Snyk 프로젝트 [{{ snyk_project_name }}]({{ snyk_project_url }})를 참조하십시오.

사용자 정의 PR 템플릿 유효성 검사

각 섹션에 설명된 단계에 따라 템플릿의 정확성을 검증할 수 있습니다.

API 템플릿 유효성 검사

API 구성의 경우, 다음 단계에 따라 템플릿의 정확성을 검증할 수 있습니다.

1. 오류 응답이 반환되면 사용자 정의 콘텐츠에 문제가 있는 것입니다. 문제를 수정한 후 API 성공 응답을 받을 때까지 기다리십시오.

2. PR을 생성하고 사용자 정의 입력 사항이 사용되는지 확인하십시오.

YAML 템플릿 유효성 검사

다음 단계에 따라 템플릿의 정확성을 검증할 수 있습니다.

1. 프로젝트(리포지토리)에 템플릿 파일을 추가합니다.

2. PR을 생성하고 사용자 정의 입력 사항이 사용되는지 확인하십시오.