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

워크플로 YAML 정의

다음은 워크플로 정의 파일의 참조 설명서입니다.

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

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

워크플로 정의 파일의 예

다음은 간단한 워크플로 정의 파일의 예입니다. 여기에는 몇 가지 최상위 속성, Triggers 섹션 및 Build 및 두 가지 작업이 있는 Actions 섹션이 포함됩니다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 구문 지침

워크플로 정의 파일은 에 작성YAML되고 YAML 1.1 사양 을 따르므로 해당 사양에서 허용되는 모든 항목도 워크플로 에서 허용됩니다YAML. 를 처음 사용하는 경우 유효한 YAML 코드를 제공하기 위한 몇 가지 빠른 지침이 YAML있습니다.

이름 지정 규칙

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

최상위 속성

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

# 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.

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

해당 UI: 시각적editor/Workflow properties/Advanced/실행 모드

Compute

(선택 사항)

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

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

해당 UI: 없음

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

Type

(Compute/Type)

(Compute이 설정된 경우 필수)

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

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

해당 UI: 시각적editor/Workflow properties/Advanced/컴퓨트 유형

Fleet

(Compute/Fleet)

(선택 사항)

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

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

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

컴퓨팅 플릿에 대한 자세한 내용은 섹션을 참조하세요컴퓨팅 플릿.

해당 UI: 시각적 editor/Workflow properties/Advanced/ 컴퓨팅 플릿

SharedInstance

(Compute/SharedInstance)

(선택 사항)

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

컴퓨팅 공유에 대한 자세한 내용은 섹션을 참조하세요작업 간 컴퓨팅 공유.

해당 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이 설정된 경우 필수)

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

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

해당 UI: 시각적editor/workflow diagram/Triggers/트리거 유형

Events

(Triggers/Events)

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

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

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

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

해당 UI: 풀 요청에 대한 시각적editor/workflow diagram/Triggers/이벤트

Branches

(Triggers/Branches)

(선택 사항)

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

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

브랜치 및 트리거에 대한 자세한 내용은 섹션을 참조하세요트리거 및 브랜치에 대한 사용 지침.

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

해당 UI: 시각적editor/workflow diagram/Triggers/브랜치

FilesChanged

(Triggers/FilesChanged)

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

워크플로 실행을 시작해야 하는 시기를 알 수 있도록 트리거가 모니터링하는 소스 리포지토리의 파일 또는 폴더를 지정합니다. 정규식을 사용하여 파일 이름 또는 경로와 일치시킬 수 있습니다.

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

해당 UI: 시각적 editor/workflow diagram/Triggers/파일 변경됨

Expression

(Triggers/Expression)

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

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

의 Cron 표현식은 다음 6개 필드 구문을 CodeCatalyst 사용하며, 여기서 각 필드는 공백으로 구분됩니다.

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

cron 표현식의 예

에서 cron 표현식을 지정할 때는 다음 지침을 따라야 CodeCatalyst합니다.

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

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

해당 UI: 시각적editor/workflow diagram/Triggers/일정

작업

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

각 작업 유형에 대한 자세한 내용은 섹션을 참조하세요작업 유형. 작업 유형 주제에는 각 작업에 대한 설명서 링크가 있습니다.

다음은 워크플로 정의 파일의 작업 및 작업 그룹에 대한 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/Configuration 탭/작업 이름 또는 작업 표시 이름

action-group-name

(Actions/action-group-name)

(선택 사항)

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

Replace action-group-name 작업 그룹에 부여하려는 이름이 있습니다. 작업 그룹 이름은 워크플로 내에서 고유해야 하며 영숫자 문자, 하이픈 및 밑줄만 포함해야 합니다. 구문 규칙에 대한 자세한 내용은 섹션을 참조하세요YAML 구문 지침.

작업 그룹에 대한 자세한 내용은 섹션을 참조하세요작업을 작업 그룹으로 그룹화.

해당 UI: 없음