Run Action
Deplite/run-action@v0은 Agent와 workflow 이름으로 기기 워크플로우를 실행해요.
기본 설정은 실행이 끝날 때까지 기다리고 기기 로그를 GitHub Actions 로그에 표시해요.
필요한 토큰 권한
실행할 Agent의 agent 권한 또는 특정 Agent와 workflow에 묶인 workflow 권한의 API 토큰을 사용해주세요.
토큰은 GitHub Actions secret으로 저장하고 api-token 입력에 전달해주세요.
Inputs
| 이름 | 필수 | 기본값 | 설명 |
|---|---|---|---|
api-token | ✅ | — | Deplite Bearer API 토큰 |
agent | ✅ | — | 실행할 Agent 이름 |
workflow | ✅ | — | 실행할 workflow 이름 |
params | — | workflow 입력값을 담은 JSON 객체 문자열 | |
ref | GITHUB_REF_NAME | Git 브랜치 또는 태그 이름. workflow의 on.webhook.refs 범위와 맞춰주세요 | |
debug | false | 디버그 실행 여부 | |
wait | true | 기기 workflow가 끝날 때까지 기다릴지 설정 | |
wait-timeout-minutes | 60 | 기다릴 최대 시간(분) | |
logs | true | 기기 로그를 GitHub Actions 로그에 표시할지 설정 | |
idempotency-key | 자동 생성 | 자동 생성 키 대신 사용할 Idempotency-Key | |
approval-key-id | — | 승인 정책에 등록한 key ID | |
approval-secret | — | HMAC workflow 승인에 사용할 비밀 키 | |
approval-private-key | — | Ed25519 또는 ECDSA P-256 workflow 승인에 사용할 PEM 개인 키 | |
base-url | https://api.deplite.io/v1 | Deplite API 베이스 URL 오버라이드 |
params는 JSON 객체여야 해요.
승인 정책을 사용하는 workflow는 approval-key-id와 approval-secret 또는 approval-private-key 중 하나를 함께 설정해주세요.
Outputs
| 이름 | 설명 |
|---|---|
job-id | Deplite에서 만든 실행 job ID |
status | Deplite가 반환한 job 상태 |
exit-code | 기기 workflow 종료 코드 |
output | workflow 결과를 담은 JSON 문자열 |
console-url | Deplite 콘솔의 job 주소 |
wait: false이면 완료 결과 대신 접수 시점의 job ID와 상태를 받아요.
실행 완료 결과가 필요한 경우 기본값인 wait: true를 유지해주세요.
사용 예시
name: Deploy
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Run Deplite workflow
id: deplite
uses: Deplite/run-action@v0
with:
api-token: ${{ secrets.DEPLITE_API_TOKEN }}
agent: production-device
workflow: deploy
params: '{"version":"1.2.3"}'ref를 따로 지정하지 않으면 GitHub Actions가 제공하는 현재 브랜치·태그의 짧은 이름 GITHUB_REF_NAME을 사용해요.
워크플로우 YAML의 on.webhook.refs에 해당 이름을 허용해주세요.
오류와 주의점
agent와 workflow 이름은 콘솔에 표시된 이름과 일치해야 해요.
워크플로우 YAML에 on.webhook 호출 허용 선언이 없거나, 지정한 ref가 허용 범위 밖이면 실행 요청이 거절돼요.
필수 입력이 빠졌거나 params가 JSON 객체가 아니면 Actions step이 실패해요.
기본 대기 제한은 60분이에요.
대기 제한에 도달하면 Actions step은 실패하지만 기기 workflow는 계속 실행될 수 있으니 콘솔 URL에서 상태를 확인해주세요.
승인 입력은 approval-key-id와 HMAC 비밀 키 또는 PEM 개인 키 중 정확히 하나의 조합으로 설정해주세요.