이벤트 정의 가이드
이벤트 사전은 진행 중인 작업이며,이 프로세스는 변경될 수 있습니다.
본 안내서는 이벤트 사전과 해당 구현에 대해 설명합니다.
이벤트 정의 및 유효성 검사
이 프로세스는 모든 내부 이벤트를 문서화하고 일관성을 보장하기 위한 것입니다. 모든 내부 이벤트에는 그러한 정의가 필요합니다. 이벤트 정의는 JSON Schema를 준수해야 합니다.
모든 이벤트 정의는 다음 디렉터리에 저장됩니다.
각 이벤트는 다음 필드로 구성된 별도의 YAML 파일에서 정의됩니다.
| 필드 | 필수여부 | 추가 정보 |
|---|---|---|
description
| 예 | 이벤트에 대한 설명입니다. |
internal_events
| 아니오 | 내부 이벤트에서 사용되는 이벤트에 대해 항상 true.
|
category
| 아니오 | 레거시 이벤트에 대해 필수입니다. 내부 이벤트에 사용하면 안 됩니다. |
action
| 예 | 이벤트에 대한 고유한 이름입니다. 소문자, 숫자 및 밑줄만 허용됩니다. <operation>_<target_of_operation>_<where/when> 형식을 사용합니다. 예: publish_go_module_to_the_registry_from_pipeline <operation> = publish<target> = go_module<when/where> = to_the_registry_from_pipeline.
|
identifiers
| 아니오 | 이벤트와 함께 전송된 식별자 디렉터리입니다. project, user, 또는 namespace 중 하나 이상으로 설정할 수 있습니다.
|
product_section
| 예 | 섹션입니다. |
product_stage
| 아니오 | 이벤트의 단계입니다. |
product_group
| 예 | 이벤트를 소유한 그룹입니다. |
milestone
| 아니오 | 이벤트가 도입된 마일스톤입니다. |
introduced_by_url
| 아니오 | 이벤트를 도입한 합병 요청의 URL입니다. |
distributions
| 예 | 추적된 기능이 제공되는 배포입니다. ce 또는 ee 중 하나 이상으로 설정할 수 있습니다.
|
tiers
| 예 | 추적된 기능이 제공되는 티어입니다. free, premium, 또는 ultimate 중 하나 이상으로 설정할 수 있습니다.
|
예시 이벤트 정의
다음은 내부 이벤트에 대한 YAML 파일의 예시입니다:
description: 사용자가 제품 분석 대시보드를 방문했습니다.
internal_events: true
action: visit_product_analytics_dashboard
identifiers:
- project
- user
- namespace
product_section: dev
product_stage: monitor
product_group: group::product analytics
milestone: "16.4"
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128029
distributions:
- ee
tiers:
- ultimate
도움말