워크플로우 관리
Codeflow 워크플로우를 설정하고 실행 이력을 관리하는 방법을 설명합니다.
워크플로우 설정
워크플로우는 코드 변경 또는 사용자의 실행 요청을 기반으로 정의된 작업을 자동으로 수행하는 기능입니다. 워크플로우는 리포지토리 내 YAML 파일로 정의하며, 기본 브랜치의 .codeflow/workflows 경로에 위치한 파일을 기준으로 워크플로우 목록이 구성됩니다.
| 구분 | 설명 |
|---|---|
| 경로 | .codeflow/workflows |
| 파일 형식 | YAML (.yml, .yaml) |
| 목록 표시 기준 | 기본 브랜치의 워크플로우 파일 기준으로 목록 표시 |
트리거 이벤트
워크플로우는 워크플로우 파일에 정의된 트리거 이벤트가 발생할 때 실행됩니다. Codeflow는 다음 이벤트를 지원합니다.
| 이벤트 | 설명 |
|---|---|
push | 리포지토리에 커밋이 푸시될 때 워크플로우를 자동으로 실행 |
workflow_dispatch | 사용자가 워크플로우를 수동으로 실행 - 정의된 파라미터가 있는 경우 실행 시 값을 입력 |
현재 Codeflow에서 지원하는 트리거 이벤트는 위 push와 workflow_dispatch 두 가지입니다.
워크플로우 시작하기
워크플로우를 실행하려면 리포지토리를 생성하고, 기본 브랜치에 워크플로우 파일을 추가한 뒤 러너를 설정해야 합니다.
- 리포지토리를 생성합니다.
- 기본 브랜치의
.codeflow/workflows경로에 YAML 형식의 워크플로우 파일을 추가합니다. 워크플로우 파일은 기본 브랜치에 있어야 목록에 표시됩니다. - 러너를 설정합니다.
- 이 문서의 워크플로우 파일 목록 및 실행을 참고하여 워크플로우를 실행하고 결과를 확인합니다.
워크플로우로 컨테이너 이미지를 빌드하고 배포 매니페스트를 갱신하는 구성 예제는 Codeflow와 Deployflow로 CI/CD 파이프라인 구축 튜토리얼에서 확인할 수 있습니다.
워크플로우 파일 목록 및 실행
리포지토리 상세 화면의 워크플로우 탭에서 기본 브랜치에 설정된 워크플로우 파일 목록을 확인하고 실행할 수 있습니다.
| 구분 | 설명 |
|---|---|
| 이름 | 워크플로우 파일 이름 |
| 최종 수정 일시 | 파일이 마지막으로 수정된 일시 |
| 빠른 실행 | 파라미터 값을 입력하고 워크플로우 실행 |
워크플로우 파일 목록에서 워크플로우 실행 버튼을 클릭하면 실행할 브랜치와 파라미터 값을 입력할 수 있습니다. 기본 브랜치가 아닌 브랜치를 선택하면 해당 브랜치에 있는 동일한 이름의 워크플로우 파일이 실행됩니다. 워크플로우 실행 시 입력 항목은 워크플로우 정의에 따라 자동으로 구성됩니다.
| 항목 | 설명 |
|---|---|
| 필수 여부 | 필수 항목은 *로 표시 |
| 기본값 | 기본값이 있는 경우 자동으로 입력 |
| 플레이스홀더 | 입력 형식에 대한 안내 문구 표시 |
| 유효성 검사 | 입력 값이 조건에 맞지 않을 경우 실행 제한 |
워크플로우에 정의된 파라미터 유형에 따라 입력 방식이 다르게 제공됩니다.
| 유형 | 입력 방식 | 설명 |
|---|---|---|
| text | 입력 필드 | 문자열 값 입력 |
| number | 숫자 입력 필드 | 숫자 값 입력 |
| boolean | 선택 버튼 | True/False 선택 |
| choice | 드롭다운 | 사전 정의된 항목 중 선택 |
워크플로우 실행 이력
리포지토리 상세 화면의 워크플로우 탭에서 워크플로우 실행 이력을 조회하여 실행 결과와 상태를 확인할 수 있습니다.
| 구분 | 설명 |
|---|---|
| 실행 일시 | 워크플로우를 실행한 일시 |
| 실행 파일 이름 | 실행한 워크플로우 파일 이름 |
| 브랜치 | 워크플로우 실행 브랜치 |
| 실행 결과 | 실행 결과 상태 - Succeeded: 실행 성공 상태 - Failed: 실행 실패 상태 - Running: 실행이 진행 중인 상태 - Queued: 실행이 대기 중인 상태 - Canceled: 실행이 취소된 상태 |
| 실행자 | 워크플로우를 실행한 사용자 |
| 가동 시간 | 실행 완료까지 걸린 시간 |
워크플로우 실행 취소
워크플로우 실행 상태가 Running, Queued인 경우 실행을 취소할 수 있습니다. 실행 이력 목록에서 대상 항목의 [⋮] 버튼 > 실행 취소를 선택한 후 팝업창에서 내용을 확인하고 [실행 취소] 버튼을 클릭합니다.
워크플로우 로그 보기
워크플로우 실행 로그는 실행 이력 목록에서 대상 항목의 [⋮] 버튼 > 로그 보기를 선택하여 확인합니다. 로그 확인 후 팝업창에서 [닫기] 버튼을 클릭합니다.
워크플로우 실행 이력 삭제
워크플로우 실행 상태가 Running, Queued가 아닌 경우 실행 이력을 삭제할 수 있습니다. 실행 이력 목록에서 대상 항목의 [⋮] 버튼 > 삭제를 선택한 후 팝업창에서 내용을 확인하고 [삭제] 버튼을 클릭합니다.