search

변수 목록 및 설명

템플릿에서 다음 변수들을 사용할 수 있습니다.

jira_ids: string[]

풀 리퀘스트에 포함된 이슈와 관련된 Jira 티켓 목록입니다. 프로젝트가 포함된 리포지토리나 프로젝트에서 Snyk Jira 통합이 활성화되어 있고, Snyk 이슈를 Jira 티켓에 연결했는지 확인하십시오.

Jira를 관련 풀 리퀘스트에 자동으로 연결하려면 커밋 메시지에 관련 Jira 티켓 목록을 포함하십시오.

입력

{
    "data": {
        "attributes": {
            "commit_message": "이 풀 리퀘스트는 Snyk에서 생성되었으며 {{ jira_ids }}와 관련이 있습니다." 
        },
        "type": "pull_request_template"
    }
}

출력

PR의 커밋 메시지는 다음과 같습니다.

이 풀 리퀘스트는 Snyk에서 생성되었으며 JIRA-1,JIRA-2,JIRA-3와 관련이 있습니다.

이 출력은 제안된 솔루션이 세 개의 문제를 성공적으로 해결했음을 나타냅니다. 또한 각 Jira 티켓에 대한 링크도 포함됩니다.

snyk_project_url: string

Snyk 프로젝트 URL이며, Snyk 프로젝트 페이지로 링크하는 데 사용할 수 있습니다.

입력

출력

PR의 설명은 다음과 같습니다.

이 출력에서 my-org는 Snyk 조직 이름이고 xx-xxx-xx-xx-xxxx는 프로젝트 또는 리포지토리의 공개 ID입니다.

snyk_project_name: string

Snyk 프로젝트 이름입니다. 설명에 Snyk 프로젝트 이름을 추가할 수 있습니다.

입력

출력

PR의 설명은 다음과 같습니다.

snyk_org_name: string

Snyk 조직 이름입니다. 설명에 Snyk 조직 이름을 추가할 수 있습니다.

입력

출력

PR의 설명은 다음과 같습니다.

package_name: string

수정 또는 업그레이드되는 패키지의 이름입니다. 둘 이상의 패키지가 변경되는 경우, 이 변수는 기본적으로 첫 번째 패키지로 설정됩니다.

PR에서 수정되는 첫 번째 종속성의 패키지 이름을 설명에 표시하려면 다음 예시를 따르십시오.

입력

출력

PR의 설명은 다음과 같습니다.

package_from: string

수정 또는 업그레이드되는 패키지의 버전입니다. 둘 이상의 패키지가 변경되는 경우, 이 변수는 기본적으로 첫 번째 패키지의 'from' 버전으로 설정됩니다.

입력

출력

PR의 설명은 다음과 같습니다.

package_to: string

패키지가 전환되는 특정 버전입니다. 둘 이상의 패키지가 변경되는 경우, 이 변수는 기본적으로 첫 번째 패키지의 'to' 버전으로 설정됩니다.

입력

출력

PR의 설명은 다음과 같습니다.

issue_count: number

PR에 의해 해결되는 프로젝트 또는 리포지토리의 이슈 수입니다.

입력

출력

PR의 설명은 다음과 같습니다.

product_is_container: boolean

PR이 Snyk Container 제품인지 여부에 따라 속성을 사용자 정의하는 데 사용됩니다. 현재 Snyk에는 PR을 열 수 있는 두 가지 제품 유형(Snyk Open Source 및 Snyk Container)이 있습니다. 이 변수를 사용하면 두 제품을 구분하도록 템플릿을 사용자 정의할 수 있습니다.

입력

출력

PR이 Open Source 제품인 경우 설명은 다음과 같습니다.

product_is_open_source: boolean

PR이 오픈 소스 제품인지 여부에 따라 속성을 사용자 정의하는 데 사용됩니다. 현재 Snyk에는 PR을 열 수 있는 두 가지 제품 유형(Open-Source 및 Container)이 있습니다. 이 변수를 사용하면 두 제품을 구분하도록 템플릿을 사용자 정의할 수 있습니다.

입력

출력

PR이 Open Source 제품인 경우 설명은 다음과 같습니다.

is_fix_pr: boolean

PR이 최신 스캔에서 프로젝트 또는 리포지토리에 도입된 새로운 취약점을 수정하기 위해 열린 수정(fix) PR인지 여부에 따라 속성을 사용자 정의하는 데 사용됩니다. 아래 예시에서 PR 설명은 수정 PR인 경우에만 표시됩니다.

입력

출력

PR이 수정 PR인 경우 설명은 다음과 같습니다.

is_backlog_pr: boolean

PR이 이미 프로젝트 또는 리포지토리에 있는 알려진 취약점을 수정하기 위해 열린 백로그(backlog) PR인지 여부에 따라 속성을 사용자 정의하는 데 사용됩니다. 아래 예시에서 PR 설명은 백로그 PR인 경우에만 표시됩니다.

입력

출력

PR이 백로그 PR인 경우 설명은 다음과 같습니다.

is_upgrade_pr: boolean

PR이 취약점 여부와 관계없이 종속성을 최신 버전으로 업데이트하기 위한 업그레이드(Upgrade) PR인지 여부에 따라 속성을 사용자 정의하는 데 사용됩니다. 아래 예시에서 PR 설명은 업그레이드 PR인 경우에만 표시됩니다.

입력

출력

PR이 업그레이드 PR인 경우 설명은 다음과 같습니다.

files_changed

풀 리퀘스트의 일부로 변경된 파일들을 나열하기 위해 템플릿에서 사용할 수 있는 변수입니다.

입력

출력

Maven 프로젝트에 대한 풀 리퀘스트이고 pom.xml 파일이 변경된 경우 PR 설명은 다음과 같습니다.

container.recommended_base_image_name

컨테이너 프로젝트 전용 변수입니다. 이 PR에 적용된 권장 베이스 이미지의 이름을 표시하는 데 사용됩니다.

입력

출력

PR의 설명은 다음과 같습니다.

container.current_base_image_name

컨테이너 프로젝트 전용 변수입니다. 현재 사용 중인 베이스 이미지를 표시하는 데 사용됩니다.

입력

출력

PR의 설명은 다음과 같습니다.

container.recommended_base_image_short_name

컨테이너 프로젝트 전용 변수입니다. 레지스트리 접두사를 제거하여 전체 권장 베이스 이미지 경로에서 짧은 이미지 이름(이미지:태그)을 추출합니다.

예를 들어, docker.io/library/node:18-alpine은 node:18-alpine이 됩니다.

입력

출력

PR의 설명은 다음과 같습니다.

container.current_base_image_short_name

컨테이너 프로젝트 전용 변수입니다. 레지스트리 접두사를 제거하여 전체 현재 베이스 이미지 경로에서 짧은 이미지 이름(이미지:태그)을 추출합니다.

예를 들어, docker.io/library/node:16은 node:16이 됩니다.

입력

출력

PR의 설명은 다음과 같습니다.

snyk_pull_request_type: prType (fix, upgrade, backlog, unknown)

프로젝트 또는 리포지토리의 prType입니다. 풀 리퀘스트 설명에 PR 유형을 표시하는 데 사용할 수 있습니다.

입력

출력

수정(Fix) PR을 연 경우 커밋 메시지는 다음과 같습니다.

Previous사용자 정의 PR 템플릿 적용Next사용자 정의 PR 템플릿 문제 해결 및 제한 사항

Last updated