워크플로우 YAML 정의 - 아마존 CodeCatalyst
워크플로 정의 파일의 예구문 지침 및 규칙최상위 속성

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

워크플로우 YAML 정의

다음은 워크플로 정의 파일에 대한 참조 문서입니다.

워크플로 정의 파일은 워크플로를 설명하는 YAML 파일입니다. 기본적으로 파일은 소스 리포지토리의 루트에 있는 ~/.codecatalyst/workflows/ 폴더에 저장됩니다. 파일 확장자는.yml 또는.yaml일 수 있으며 확장자는 소문자여야 합니다.

워크플로 정의 파일을 만들고 편집하려면 vim과 같은 편집기를 사용하거나 콘솔의 시각적 편집기 또는 편집기를 사용할 수 있습니다. CodeCatalyst YAML 자세한 내용은 CodeCatalyst 콘솔의 비주얼 및 YAML 에디터 사용 단원을 참조하십시오.

참고

다음에 나오는 대부분의 YAML 속성에는 비주얼 편집기에 해당하는 UI 요소가 있습니다. UI 요소를 검색하려면 Ctrl+F를 사용합니다. 요소가 관련 YAML 속성과 함께 나열됩니다.

워크플로 정의 파일의 예

다음은 간단한 워크플로 정의 파일의 예입니다. 여기에는 몇 가지 최상위 속성, Triggers 섹션 및 두 개의 작업 (및) 이 있는 Actions 섹션이 포함됩니다. Build Test 자세한 내용은 워크플로우 정의 파일 정보 단원을 참조하십시오.

Name: MyWorkflow
SchemaVersion: 1.0
RunMode: QUEUED
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:     
      Steps:
        - Run: docker build -t MyApp:latest .
  Test:
    Identifier: aws/managed-test@v1
    DependsOn: 
      - Build
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
        - Run: npm install
        - Run: npm run test

구문 지침 및 규칙

이 섹션에서는 워크플로 정의 파일의 구문 규칙과 이 참조 문서에 사용되는 이름 지정 규칙에 대해 설명합니다.

YAML구문 가이드라인

워크플로 정의 파일은 YAML1.1 사양에 따라 작성되므로 해당 사양에서 허용되는 모든 항목이 워크플로우에서도 허용됩니다YAML. YAML 처음 사용하는 경우 올바른 YAML 코드를 제공하는지 확인할 수 있는 몇 가지 간단한 지침이 있습니다. YAML

  • 대소문자 구분: 워크플로 정의 파일은 대소문자를 구분하므로 이 설명서에 표시된 대소문자를 사용해야 합니다.

  • 특수 문자: 속성 값 앞에는,,,, &,,,, <, >{,, } [ ] * # ? |-, 및 등의 특수 문자가 포함된 따옴표나 큰 따옴표를 사용하는 것이 좋습니다. = ! % @ : ` ,

    따옴표를 포함하지 않으면 이전에 나열된 특수 문자가 예상치 못한 방식으로 해석될 수 있습니다.

  • 속성 이름: 속성 이름 (속성 값과 반대) 은 영숫자 (a-z, A-Z, 0-9), 하이픈 (-) 및 밑줄 (_) 로 제한됩니다. 공백은 허용되지 않습니다. 속성 이름에 특수 문자와 공백을 사용할 때는 따옴표나 큰따옴표를 사용할 수 없습니다.

    허용되지 않음:

    'My#Build@action'

    My#Build@action

    My Build Action

    허용:

    My-Build-Action_1

  • 이스케이프 코드: 속성 가치에 이스케이프 코드 (예: \n 또는\t) 가 포함된 경우 다음 가이드라인을 따르세요.

    • 이스케이프 코드를 문자열로 반환하려면 작은따옴표를 사용하십시오. 예를 들어'my string \n my string', 는 문자열을 my string \n my string 반환합니다.

    • 큰따옴표를 사용하여 이스케이프 코드를 파싱합니다. 예를 들어"my string \n my new line", 는 다음을 반환합니다.

      my string
my new line

  • 댓글: 댓글 앞에 를 붙입니다. #

    예제: 

    Name: MyWorkflow
# This is a comment.
SchemaVersion: 1.0

  • 트리플 대시 (---): --- 코드에 사용하지 마세요. YAML CodeCatalyst 뒤에 오는 모든 항목을 무시합니다. ---

이름 지정 규칙

이 가이드에서는 속성 및 섹션이라는 용어를 사용하여 워크플로 정의 파일의 기본 항목을 참조합니다.

  • 속성은 콜론 (:) 이 포함된 모든 항목입니다. 예를 들어, 다음 코드 스니펫에서는 다음이 모두 속성입니다.Name,,, SchemaVersion RunModeTriggers, Type 및. Branches

  • 섹션은 하위 속성이 있는 모든 속성입니다. 다음 코드 스니펫에는 섹션이 하나 있습니다. Triggers

    참고

    이 가이드에서 '섹션'은 상황에 따라 '속성'이라고도 하며, 그 반대의 경우도 마찬가지입니다.

    Name: MyWorkflow
SchemaVersion: 1.0
RunMode: QUEUED
Triggers:
  - Type: PUSH
    Branches:
      - main

최상위 속성

다음은 워크플로 정의 파일의 최상위 속성에 대한 참조 문서입니다.

# Name
Name: workflow-name
        
# Schema version
SchemaVersion: 1.0
        
# Run mode
RunMode: QUEUED|SUPERSEDED|PARALLEL

# Compute
Compute:  
...
            
# Triggers
Triggers:
...

# Actions
Actions:
...

Name

(필수)

워크플로의 이름입니다. 워크플로 이름은 워크플로 목록에 표시되며 알림 및 로그에 언급됩니다. 워크플로 이름과 워크플로 정의 파일 이름이 일치할 수도 있고 이름을 다르게 지정할 수도 있습니다. 워크플로 이름은 고유하지 않아도 됩니다. 워크플로 이름은 영숫자 (a-z, A-Z, 0-9), 하이픈 (-) 및 밑줄 (_) 로 제한됩니다. 공백은 허용되지 않습니다. 워크플로 이름에 특수 문자와 공백을 사용할 때는 따옴표를 사용할 수 없습니다.

해당 UI: 비주얼 에디터/워크플로 속성/워크플로 이름

SchemaVersion

(필수)

워크플로 정의의 스키마 버전. 현재 유일한 유효 값은 1.0입니다.

해당 UI: 없음

RunMode

(선택 사항)

다중 실행을 CodeCatalyst 처리하는 방법 다음 값 중 하나를 사용할 수 있습니다.

  • QUEUED— 여러 실행이 대기열에 추가되어 차례로 실행됩니다. 대기열에 최대 50개의 런을 넣을 수 있습니다.

  • SUPERSEDED— 여러 실행이 대기열에 추가되어 차례로 실행됩니다. 대기열에는 한 번만 실행할 수 있으므로 두 실행이 같은 대기열에 있는 경우 이후 실행이 이전 실행을 대체 (인계) 하여 이전 실행이 취소됩니다.

  • PARALLEL— 여러 실행이 동시에 발생합니다.

이 속성을 생략할 경우 기본값은 입니다. QUEUED

자세한 내용은 실행의 대기열 동작 구성 단원을 참조하십시오.

해당 UI: 비주얼 에디터/워크플로 속성/고급/실행 모드

Compute

(선택 사항)

워크플로 작업을 실행하는 데 사용되는 컴퓨팅 엔진입니다. 워크플로 수준 또는 작업 수준에서 컴퓨팅을 지정할 수 있지만 둘 다에서 지정할 수는 없습니다. 워크플로 수준에서 지정된 경우 컴퓨팅 구성은 워크플로에 정의된 모든 작업에 적용됩니다. 워크플로 수준에서는 동일한 인스턴스에서 여러 작업을 실행할 수도 있습니다. 자세한 내용은 작업 간 컴퓨팅 공유 단원을 참조하십시오.

컴퓨팅에 대한 자세한 내용은 을 참조하십시오컴퓨팅 및 런타임 이미지 구성.

해당 UI: 없음

Name: MyWorkflow
SchemaVersion: 1.0
...
Compute:  
  Type: EC2 | Lambda
  Fleet: fleet-name
  SharedInstance: true | false

Type

(Compute/Type)

(Compute설정된 경우 필수)

컴퓨팅 엔진 유형. 다음 값 중 하나를 사용할 수 있습니다.

  • EC2(비주얼 에디터) 또는 EC2 (YAML에디터)

    작업 실행 중 유연성을 위해 최적화되었습니다.

  • Lambda (비주얼 에디터) 또는 (에디터) Lambda YAML

    작업 시작 속도를 최적화했습니다.

컴퓨팅 유형에 대한 자세한 정보는 컴퓨팅 유형을 참고하세요.

해당 UI: 비주얼 에디터/워크플로 속성/고급/컴퓨팅 유형

Fleet

(Compute/Fleet)

(선택 사항)

워크플로 또는 워크플로 작업을 실행할 컴퓨터 또는 플릿을 지정합니다. 온디맨드 플릿을 사용하면 작업이 시작되면 워크플로에서 필요한 리소스를 프로비저닝하고 작업이 완료되면 시스템이 폐기됩니다. 온디맨드 플릿의 예:,. Linux.x86-64.Large Linux.x86-64.XLarge 온디맨드 플릿에 대한 자세한 내용은 을 참조하십시오. 온디맨드 플릿 속성

프로비전된 플릿을 사용하면 워크플로 작업을 실행할 전용 컴퓨터 세트를 구성합니다. 이러한 시스템은 유휴 상태로 유지되므로 작업을 즉시 처리할 수 있습니다. 프로비전된 플릿에 대한 자세한 내용은 을 참조하십시오. 프로비저닝된 플릿 속성

생략된 경우 기본값은 Fleet 입니다. Linux.x86-64.Large

컴퓨팅 플릿에 대한 자세한 내용은 을 참조하십시오. 컴퓨팅 플릿

해당 UI: 비주얼 에디터/워크플로 속성/고급/컴퓨트 플릿

SharedInstance

(Compute/SharedInstance)

(선택 사항)

작업에 대한 컴퓨팅 공유 기능을 지정하십시오. 컴퓨팅 공유를 사용하면 워크플로의 작업이 동일한 인스턴스 (런타임 환경 이미지) 에서 실행됩니다. 다음 값 중 하나를 사용할 수 있습니다.

  • TRUE런타임 환경 이미지가 워크플로 작업 간에 공유됨을 의미합니다.

  • FALSE워크플로의 각 작업에 대해 별도의 런타임 환경 이미지가 시작되어 사용되므로 추가 구성 없이는 아티팩트 및 변수와 같은 리소스를 공유할 수 없습니다.

컴퓨팅 공유에 대한 자세한 내용은 을 참조하십시오작업 간 컴퓨팅 공유.

해당 UI: 없음

Triggers

(선택 사항)

이 워크플로에 대한 하나 이상의 트리거 시퀀스. 트리거가 지정되지 않은 경우 워크플로를 수동으로 시작해야 합니다.

트리거에 대한 자세한 내용은 트리거를 사용하여 자동으로 워크플로 실행 시작 주제를 참조하십시오.

해당 UI: 비주얼 에디터/워크플로 다이어그램/트리거

Name: MyWorkflow
SchemaVersion: 1.0
...
Triggers:
  - Type: PUSH
    Branches:
      - branch-name
    FilesChanged:
      - folder1/file
      - folder2/
 
  - Type: PULLREQUEST
    Events:
      - OPEN
      - CLOSED
      - REVISION
    Branches:
      - branch-name
    FilesChanged:
      - file1.txt
      
  - Type: SCHEDULE
    # Run the workflow at 10:15 am (UTC+0) every Saturday
    Expression: "15 10 ? * 7 *"
    Branches:
      - branch-name

Type

(Triggers/Type)

(설정된 경우 필수) Triggers

트리거 유형을 지정합니다. 다음 값 중 하나를 사용할 수 있습니다.

  • 푸시 (비주얼 에디터) 또는 PUSH (YAML에디터)

    푸시 트리거는 변경 내용이 소스 저장소에 푸시될 때 워크플로 실행을 시작합니다. 워크플로 실행 시 푸시하려는 브랜치 (즉, 대상 브랜치) 의 파일이 사용됩니다.

  • 풀 리퀘스트 (비주얼 에디터) 또는 PULLREQUEST (YAML에디터)

    풀 리퀘스트 트리거는 소스 리포지토리에서 풀 리퀘스트를 열거나 업데이트하거나 닫을 때 워크플로 실행을 시작합니다. 워크플로 실행에서는 가져오는 브랜치 (즉, 소스 브랜치) 의 파일을 사용합니다.

  • 스케줄 (비주얼 에디터) 또는 SCHEDULE (YAML에디터)

    스케줄 트리거는 지정한 cron 표현식으로 정의된 일정에 따라 워크플로가 실행됩니다. 브랜치의 파일을 사용하여 소스 리포지토리의 각 브랜치에 대해 별도의 워크플로 실행이 시작됩니다. (트리거가 활성화되는 브랜치를 제한하려면 Branch 필드 (시각적 편집기) 또는 Branches 속성 (YAML편집기) 을 사용하십시오.)

    스케줄 트리거를 구성할 때는 다음 가이드라인을 따르십시오.

    • 워크플로우당 하나의 스케줄 트리거만 사용하십시오.

    • CodeCatalyst 스페이스에 여러 워크플로를 정의한 경우 동시에 시작하도록 10개 이하로 예약하는 것이 좋습니다.

    • 실행 간격을 충분히 두고 트리거의 cron 표현식을 구성해야 합니다. 자세한 내용은 Expression 단원을 참조하십시오.

예제는 예: 워크플로의 트리거 섹션을 참조하세요.

해당 UI: 비주얼 에디터/워크플로 다이어그램/트리거/트리거 유형

Events

(Triggers/Events)

(트리거가 로 설정된 경우 필수) Type PULLREQUEST

워크플로 실행을 시작할 풀 요청 이벤트의 유형을 지정합니다. 유효한 값은 다음과 같습니다.

  • 풀 리퀘스트가 생성됨 (비주얼 에디터) 또는 OPEN (YAML에디터)

    풀 리퀘스트가 생성되면 워크플로 실행이 시작됩니다.

  • 풀 리퀘스트가 종료됨 (비주얼 에디터) 또는 CLOSED (YAML에디터)

    풀 리퀘스트가 종료되면 워크플로 실행이 시작됩니다. CLOSED이벤트의 동작은 까다롭기 때문에 예제를 통해 가장 잘 이해할 수 있습니다. 자세한 내용은 예: 풀, 브랜치, CLOSED '이벤트가 있는 트리거 섹션을 참조하세요.

  • 풀 리퀘스트 (비주얼 에디터) 또는 REVISION (YAML에디터) 가 새롭게 수정되었습니다.

    풀 리퀘스트에 대한 수정이 생성되면 워크플로 실행이 시작됩니다. 풀 리퀘스트가 생성되면 첫 번째 리비전이 생성됩니다. 그 이후에는 누군가가 풀 리퀘스트에 지정된 소스 브랜치에 새 커밋을 푸시할 때마다 새 리비전이 생성됩니다. 풀 리퀘스트 트리거에 REVISION 이벤트를 포함하면 OPEN 이벤트를 생략할 수 있습니다. 는 의 상위 REVISION 집합이기 때문입니다. OPEN

동일한 풀 리퀘스트 트리거에 여러 이벤트를 지정할 수 있습니다.

예제는 예: 워크플로의 트리거 섹션을 참조하세요.

해당 UI: 비주얼 에디터/워크플로 다이어그램/트리거/풀 리퀘스트용 이벤트

Branches

(Triggers/Branches)

(선택 사항)

워크플로우 실행 시작 시기를 알기 위해 트리거가 모니터링하는 소스 리포지토리의 브랜치를 지정하세요. 정규식 패턴을 사용하여 브랜치 이름을 정의할 수 있습니다. 예를 들어 로 시작하는 모든 브랜치를 main.* 일치시키는 데 사용합니다. main

지정할 브랜치는 트리거 유형에 따라 다릅니다.

  • 푸시 트리거의 경우 푸시하려는 브랜치, 즉 대상 브랜치를 지정하세요. 일치하는 브랜치의 파일을 사용하여 일치하는 브랜치당 한 번의 워크플로 실행이 시작됩니다.

    예: main.*, mainline

  • 풀 리퀘스트 트리거의 경우 푸시하려는 브랜치, 즉 대상 브랜치를 지정하세요. 일치하는 브랜치가 아닌 소스 브랜치의 소스 파일과 워크플로 정의 파일을 사용하여 일치하는 브랜치당 한 번의 워크플로 실행이 시작됩니다.

    예:main.*,mainline, v1\-.* (로 시작하는 브랜치와 일치v1-)

  • 스케줄 트리거의 경우 예약 실행에서 사용할 파일이 포함된 브랜치를 지정하십시오. 일치하는 브랜치의 워크플로 정의 파일과 소스 파일을 사용하여 일치하는 브랜치당 한 번의 워크플로 실행이 시작됩니다.

    예: main.*, version\-1\.0

참고

브랜치를 지정하지 않으면 트리거는 소스 리포지토리의 모든 브랜치를 모니터링하고 다음 위치에 있는 워크플로 정의 파일 및 소스 파일을 사용하여 워크플로 실행을 시작합니다.

브랜치 및 트리거에 대한 자세한 내용은 을 참조하십시오트리거 및 브랜치에 대한 사용 지침.

더 많은 예제는 예: 워크플로의 트리거를 참조합니다.

해당 UI: 비주얼 에디터/워크플로 다이어그램/트리거/브랜치

FilesChanged

(Triggers/FilesChanged)

(트리거가 또는 로 설정된 경우 선택 사항입니다. Type PUSH PULLREQUEST Type트리거가 로 설정된 경우 지원되지 않습니다SCHEDULE.

워크플로우 실행 시작 시기를 알기 위해 트리거가 모니터링하는 소스 저장소의 파일 또는 폴더를 지정하십시오. 정규 표현식을 사용하여 파일 이름이나 경로를 일치시킬 수 있습니다.

예제는 예: 워크플로의 트리거 섹션을 참조하세요.

해당 UI: 비주얼 에디터/워크플로 다이어그램/트리거/파일 변경됨

Expression

(Triggers/Expression)

(트리거가 로 설정된 경우 필수) Type SCHEDULE

예약된 워크플로를 실행하려는 시기를 설명하는 cron 표현식을 지정하십시오.

의 크론 표현식은 각 필드를 공백으로 구분하는 다음과 같은 6개 필드 구문을 CodeCatalyst 사용합니다.

minutes hours days-of-month month days-of-week year

크론 표현식의 예

분 시간 한 달의 요일 월 요일 연도 의미

0

0

?

*

MON-FRI

*

매주 월요일부터 금요일까지 자정 (UTC+0) 에 워크플로를 실행합니다.

0

2

*

*

?

*

매일 오전 2시 (UTC+0) 에 워크플로를 실행합니다.

15

22

*

*

?

*

매일 오후 10시 15분 (UTC+0) 에 워크플로를 실행합니다.

0/30

22-2

?

*

SAT-SUN

*

토요일부터 일요일까지 시작일 오후 10시부터 다음 날 오전 2시 (UTC+0) 사이에 30분마다 워크플로를 실행합니다.

45

13

L

*

?

2023-2027

2023년부터 2027년까지 매월 마지막 날 오후 1시 45분 (UTC+0) 에 워크플로를 실행합니다.

에서 크론 표현식을 지정할 때는 다음 CodeCatalyst 지침을 준수해야 합니다.

  • 트리거당 SCHEDULE 하나의 cron 표현식을 지정하십시오.

  • 편집기에서 cron 표현식을 큰따옴표 () " 로 묶습니다. YAML

  • 시간을 협정 세계시 () 로 지정합니다. UTC 다른 시간대는 지원되지 않습니다.

  • 실행 간격을 최소 30분으로 설정하세요. 더 빠른 케이던스는 지원되지 않습니다.

  • 다음을 지정하십시오.days-of-month 또는 days-of-week 필드를 모두 포함하되 둘 다 할 수는 없습니다. 필드 중 하나에 값이나 별표 (*) 를 지정하는 경우 다른 필드에는 물음표 (?) 를 사용해야 합니다. 별표는 '모두'를 의미하고 물음표는 '모두'를 의미합니다.

cron 표현식의 추가 예와 ? *L, 및 같은 와일드카드에 대한 자세한 내용은 Amazon EventBridge 사용 설명서의 Cron 표현식 참조를 참조하십시오. EventBridge 와 에서의 크론 표현식은 정확히 같은 방식으로 CodeCatalyst 작동합니다.

스케줄 트리거에 대한 예는 을 참조하십시오. 예: 워크플로의 트리거

해당 UI: 비주얼 에디터/워크플로 다이어그램/트리거/스케줄

작업

이 워크플로에 대한 하나 이상의 작업 시퀀스. CodeCatalyst 다양한 유형의 기능을 제공하는 빌드 및 테스트 작업과 같은 여러 작업 유형을 지원합니다. 각 작업 유형에는 다음이 포함됩니다.

  • 액션의 고유한 하드 코딩된 ID를 나타내는 Identifier 속성입니다. 예를 들어, 빌드 작업을 aws/build@v1 식별합니다.

  • 해당 작업과 관련된 속성을 포함하는 Configuration 섹션.

각 작업 유형에 대한 자세한 내용은 을 참조하십시오작업 유형. 작업 유형항목에는 각 작업에 대한 설명서로 연결되는 링크가 있습니다.

다음은 워크플로 정의 파일에 있는 작업 및 작업 그룹에 대한 YAML 참조입니다.

Name: MyWorkflow
SchemaVersion: 1.0
...
Actions:
  action-or-gate-name:
    Identifier: identifier
    Configuration:
    ...
  #Action groups
  action-group-name:
    Actions:
      ...

action-or-gate-name

(Actions/action-or-gate-name)

(필수)

Replace action-name 액션에 부여하려는 이름을 사용합니다. 작업 이름은 워크플로 내에서 고유해야 하며 영숫자, 하이픈, 밑줄만 포함해야 합니다. 구문 규칙에 대한 자세한 내용은 을 참조하십시오. YAML구문 가이드라인

제한을 비롯한 작업의 이름 지정 방법에 대한 자세한 내용은 를 참조하십시오. action-or-gate-name

해당 UI: 비주얼 에디터/action-name/구성 탭/ 작업 이름 또는 작업 표시 이름

action-group-name

(Actions/action-group-name)

(선택 사항)

작업 그룹에는 하나 이상의 작업이 포함됩니다. 작업을 작업 그룹으로 그룹화하면 워크플로를 체계적으로 구성하고 여러 그룹 간의 종속성을 구성할 수 있습니다.

Replace action-group-name 작업 그룹에 지정하려는 이름을 사용합니다. 작업 그룹 이름은 워크플로 내에서 고유해야 하며 영숫자, 하이픈, 밑줄만 포함해야 합니다. 구문 규칙에 대한 자세한 내용은 을 참조하십시오. YAML구문 가이드라인

작업 그룹에 대한 자세한 내용은 을 참조하십시오작업을 작업 그룹으로 그룹화.

해당 UI: 없음