이벤트들
특정한 액티비티가 깃허브에서 발생했을 때, 스케줄한 시간에, 또는 깃허브 외부에서 이벤트가 발생했을 때, 워크플로우가 실행하도록 구성할 수 있습니다.
보통 이벤트에서 갑자기 주어 없이 실행한다는 이야기는 워크플로우 실행을 의미합니다.
#
워크플로우 이벤트에 대하여깃허브의 액티비티로 부터 온 웹훅 이벤트가 생성될 때 실행하는 워크플로우를 구성할 수 있습니다. 워크플로우는 두개 이상의 웹훅 이벤트로 워크플로우 실행을 트리거 하기 위해 사용할 수 있습니다. 자세한 내용은 "웹훅"을 참고하세요. 문법에 관한 내용은 "워크플로우 문법"을 참고하세요.
워크플로우 실행 중에 있는 액션은 새로운 워크플로우 실행을 트리거 할 수 없습니다. 예를 들면 GITHUB_TOKEN
을 사용하여 코드를 푸쉬했을 때, 새로운 워크플로우는 실행되지 않을 것입니다. 레포지토리가 push
이벤트가 발생햇을 때 실행되게 구성된 워크플로우를 포함하고 있더라도 말입니다.
워크플로우는 커밋한 SHA와 Git ref에 의해 결정된 레포지토리에서 특정 버전의 코드로 실행됩니다. 깃허브는 웹훅 이벤트 페이로드를 사용한 이벤트를 트리거한 Git ref와 commit SHA를 결정합니다. 워크플로우가 실행될 때 깃허브는 가상환경 내의 GITHUB_SHA
(commit SHA) 와 GITHUB_REF
(Git ref) 환경 변수를 설정합니다. 더 많은 정보는 "환경변수"를 참고하세요.
#
하나의 이벤트 사용 예시#
하나 이상의 이벤트 사용 예시#
웹훅 이벤트웹훅 이벤트가 생성될 때 실행될 워크플로우를 설정할 수 있습니다. 몇 이벤트들은 이벤트를 트리거 하기 위해 하나 이상의 액티비티 타입을 갖고 있습니다. 만약 둘 이상의 액티비티 타입이 이벤트를 트리거하면, 어느 액티비티 타입들이 워크플로우를 트리거 할 것인지 지정해야합니다.
check_run
#
실행 확인 이벤트: check_run
이벤트가 발생하면 워크플로우를 실행시키세요. 하나 이상의 액티비티 타입이 이 이벤트를 트리거합니다. REST API에 대해서는, "Check runs"를 참고하세요.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
check_run | - created - requested - completed - requested_action | 디폴트 브랜치의 마지막 커밋 | 디폴트 브랜치 |
디폴트로 모든 액티비티 타입들이 실행할 워크플로우를 트리거하게 되어있습니다. 특정 액티비티 타입들만 지정할 수도 있는데, types
키워드를 사용해야합니다. 자세한 내용은 "워크플로우 문법"을 참고하세요.
예를들면
check_suite
#
수트 확인 이벤트: check_suite
이벤트가 발생할 때마다 워크플로우를 실행합니다. 두 개 이상의 액티비티 타입들을 갖고 있습니다. REST API에 관한 더 자세한 내용은 Check suites를 참고하세요.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
check_suite | - completed - requested - rerequested | 디폴트 브랜치의 마지막 커밋 | 디폴트 브랜치 |
- 예
create
#
생성 이벤트: 브랜치나 태그 생성시 워크플로우 실행. "Create a reference" 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
create | n/a | 생선된 브랜치나 태그의 마지막 커밋 | 생성된 태그나 브랜치 |
- 예
delete
#
삭제 이벤트: 브랜치나 태그 삭제시 워크플로우 실행. "Delete a reference" 참고
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
delete | n/a | 디폴트 브랜치의 마지막 커밋 | 디폴트 브랜치 |
- 예
deployment
#
디플로이먼트 이벤트: deployment 생성 시 워크플로우 실행. 커밋 SHA로 만들어진 디플로이먼트는 Git ref가 없을 수도 있다. Deployments 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
deployment | n/a | 디플로이된 커밋 | 커밋 되었을 경우 empty, 아닐 경우 디플로이된 브랜치나 태그 |
- 예
deployment_status
#
디플로이먼트 상태 이벤트: third party가 deployment status를 제공할 경우 실행. 커밋 SHA로 만들어진 디플로이먼트는 Git ref가 없을 수도 있다. Create a deployment status 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
deployment_status | n/a | 디플로이된 커밋 | 커밋 되었을 경우 empty, 아닐 경우 디플로이된 브랜치나 태그 |
- 예
fork
#
포크 이벤트: 레포지토리를 포크할 때 실행. Create a fork 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
fork | n/a | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |
- 예
gollum
#
골룸 이벤트: 위키페이지 생성 및 업데이트 시 실행.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
gollum | n/a | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |
- 예
issue_comment
#
이슈 커멘트 이벤트: issue_comment
이벤트가 발생할 때마다 실행. 두 개 이상의 워크플로우를 트리거할 액티비티 타입. Issue comments 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
issue_comment | - created - edited - deleted | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |
- 예
issue
#
이슈 이벤트: issue
이벤트 발생 시 실행. 두 개 이상의 액티비티 타입. Issues 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
issues | - opened - edited - deleted - transferred - pinned - unpinned - closed - reopened - assinged - unassigned - labeled - unlabled - locked - unlocked - milestone - demilestoned | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |
디폴트로 모든 액티비티 타입이 워크플로우를 실행. types
키워드로 특정 액티비티 타입 지정 가능. 워크플로우 문법 참고.
- 예
label
#
레이블 이벤트: label
이벤트 발생 시 실행. 두 개 이상의 액티비티 타입. Labels 참고.
웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
label | - created - edited - deleted | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |
types
써서 특정 액티비티 타입들 지정 가능. 워크플로우 문법 참고.
- 예
member
#
멤버 이벤트: 웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
label | - added - edited - label | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |
#
마일스톤 이벤트#
페이지 빌드 이벤트#
프로젝트 이벤트#
프로젝트 카드 이벤트#
프로젝트 컬럼 이벤트#
퍼블릭 이벤트#
풀 요청 이벤트#
풀 리퀘스트 리뷰 이벤트#
풀 리퀘스트 리뷰 코멘트 이벤트#
푸쉬 이벤트#
릴리즈 이벤트#
상태 이벤트#
왓치 이벤트#
스케줄된 이벤트#
외부 이벤트웹훅 이벤트 페이로드 | 액티비티 타입들 | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
gollum | n/a | 마지막으로 커밋된 디폴트 브랜치 | 디폴트 브랜치 |