워크플로우 정의 레퍼런스

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

워크플로 정의 파일은 워크플로를 설명하는 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 구문 가이드라인

워크플로 정의 파일은 YAML로 작성되고 YAML 1.1 사양을 따르므로 해당 사양에서 허용되는 모든 항목이 워크플로 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
```

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

사전 정의된 변수 사용

최상위 속성