사람함께에이전트▾
사람 — 직접 정하고 책임지는 비즈니스 규칙과 흐름. 직접 읽어보세요.
함께 — 개념은 알아두고, 세부 규칙은 에이전트가 따릅니다.
에이전트 — 에이전트가 따르는 규칙과 레퍼런스. 필요할 때 찾아보세요.
CLI 레퍼런스▾
AkanJS 레퍼런스▾
파이프라인 명령
akan pipeline은 akan.config.ts에 선언한 파이프라인을 Akan Cloud가 실행할 plan으로 바꿀 뿐, 아무것도 실행하지 않습니다. push 전에 바꾼 내용을 이 명령으로 확인합니다.이 페이지에서 쓰는 말
용어설명
plan
빌드 한 번이 실행할 phase, stage, step을 담은 JSON으로, Akan Cloud가 이것을 실행합니다.
phase
함께 실행되는 stage 묶음입니다. 다음 phase는 이 phase의 stage가 모두 끝나야 시작합니다.
envelope
{ ok, plan, diagnostics } 형태의 결과로, plan이 출력하거나 --out에 씁니다.diagnostic
정의에 대한 오류나 경고로,
pipeline.action.dockerWithoutBuild 같은 코드가 붙습니다.세 가지 action
| action | 출력 | 쓰는 때 |
|---|---|---|
| dry-run | plan을 phase 순서대로 표로 보여 줍니다. | 빌드가 무엇을 실행할지 볼 때 씁니다. |
| validate | 한 줄 판정과 진단을 보여 줍니다. | push 전에 정의를 확인할 때 씁니다. |
| plan | envelope를 JSON으로 출력합니다. | plan을 다른 프로그램에 넘길 때 씁니다. |
종료 코드
| 코드 | 뜻 | envelope |
|---|---|---|
| 0 | plan을 만들었습니다. | 씁니다. ok: true입니다. |
| 1 | 정의에 오류가 있습니다. | 씁니다. ok: false와 진단이 담깁니다. |
| 2 | 그 밖의 실패입니다. 워크스페이스 루트가 아니거나, 플래그가 잘못됐거나, 쓰기에 실패했습니다. | 쓰지 않습니다. |


종료 코드 1에는 항상 envelope가 따라옵니다.
--out을 읽는 프로그램은 코드가 0이나 1이면 파일을 믿고, 2면 plan이 없다고 보면 됩니다.관련 페이지
pipeline
워크스페이스와 앱의
akan.config.ts에 선언한 빌드 파이프라인을 실행하지 않고 plan만 만듭니다.
플래그는 빌드에 대한 사실입니다. 준 플래그는 그대로 plan에 들어가고, 빠진 플래그는 git과 워크스페이스에서 채웁니다.형식
인자
actionString기본값 dry-runplan | validate | dry-run
dry-run은 plan을 보여 주고, validate는 확인하고, plan은 envelope를 출력합니다.옵션
--branchString기본값 현재 git 브랜치
빌드할 브랜치로, 모든
when.branch를 이 값으로 판정합니다.--envString기본값 브랜치 이름
빌드가 쓸
AKAN_PUBLIC_ENV입니다.--appsString기본값 모든 앱
빌드할 앱을 쉼표로 나열합니다. 없는 앱이나 중복된 앱은 오류입니다.
--triggerString기본값 manualpush | redeploy | initial | rebuild | manual
빌드를 시작한 계기로, 모든
when.trigger를 이 값으로 판정합니다.--build-numNumber기본값 0-n
빌드 번호로, 0 이상의 정수입니다.
--commitString기본값 HEAD
빌드할 커밋입니다.
--outString
envelope를 이 파일에도 씁니다. 전부 쓰거나 아예 쓰지 않습니다.
--formatString기본값 texttext | json
json이면 어느 action이든 텍스트 대신 envelope를 출력합니다.참고
이름설명
실행하지 않음
stage를 실행하지도, 무엇을 올리지도 않습니다. Akan Cloud가 빌드할 때 같은 planner를 실행합니다.
함수형
validate는 함수형 pipeline을 예시 context 하나로 실행하고, 다른 경우는 다를 수 있다고 경고합니다.종료 코드
0은 plan, 1은 envelope를 쓴 오류, 2는 envelope 없는 그 밖의 실패입니다.
예시