릴리즈 노트

GitLab 릴리즈 노트의 생성, 편집, 검토, 게시 및 관리 방법을 설명합니다.

GitLab 릴리즈 노트는 gitlab 리포지터리에 저장됩니다. 릴리즈 노트는 각 릴리즈별 디렉터리에 index.md 파일과 기능별 개별 파일로 구성됩니다. 예를 들어, 구조는 다음과 유사합니다: doc/ └─ releases/ └─ 19/ └─ gitlab-19-0-released/ │ ├── index.md │ └── featureA-Beta.md └─ gitlab-19-1-released/ ├── index.md ├── featureB.md └── featureA-GA.md 각 릴리즈에서 프로덕트 매니저는 기능 릴리즈 노트의 머지 리퀘스트와 파일을 생성할 책임이 있습니다. Technical Writing 팀은 다른 모든 디렉터리와 파일을 생성할 책임이 있습니다. 기능 릴리즈 노트 생성 # 기능 릴리즈 노트를 생성하려면: 해당 릴리즈와 관련된 디렉터리를 찾습니다. /doc/releases/19/gitlab-19-1-released/ 와 유사한 경로여야 합니다. 이 디렉터리에 기능 릴리즈 노트용 Markdown 파일을 생성합니다. 파일 이름은 중요하지 않지만, 나중에 식별하기 쉽도록 이름을 지정하는 것이 좋습니다. 아래의 템플릿 을 Markdown 파일에 붙여 넣습니다. 메타데이터 를 특정 요구 사항에 맞게 조정합니다. 문서 링크는 상대 경로여야 합니다. 작업 항목(work item) 링크가 비공개가 아닌지 확인합니다. 메타데이터 다음에 릴리즈 노트 텍스트를 작성합니다. 125단어 이하로 작성하고, 이미지나 동영상은 포함하지 않습니다. 문서 링크는 허용되지만 상대 경로여야 합니다. 다른 리소스 링크도 허용됩니다. 머지 리퀘스트를 생성합니다: Release Notes Item 템플릿을 사용하여 설명을 작성하고 진행 상황을 추적합니다. 머지 리퀘스트를 Engineering Manager와 Technical Writer에게 할당하여 검토를 받습니다. 모든 릴리즈 노트는 해당 릴리즈에 포함되기 위해 릴리즈 당일 전 금요일 23:59 UTC까지 머지되어야 합니다. 기능 릴리즈 노트 편집 또는 삭제 # 기능 릴리즈 노트를 업데이트하거나 완전히 삭제해야 하는 경우, 요청한 변경 사항으로 머지 리퀘스트를 만들고 Technical Writer에게 할당하여 검토를 받습니다. 기능 릴리즈 노트를 삭제하려면 관련 파일만 삭제하면 됩니다. 다른 파일은 조정할 필요가 없습니다. 카테고리 검증 건너뛰기 # 머지 리퀘스트가 릴리즈 노트를 변경하면 docs-lint release-note-categories CI/CD job이 categories 값을 categories.yml 과 대조하여 검증합니다. 카테고리는 때때로 이름이 변경되거나 제거되므로, 오래된 릴리즈 노트는 더 이상 존재하지 않는 카테고리를 사용할 수 있으며 이 경우 job이 실패합니다. 이 검증을 건너뛰려면 머지 리퀘스트에 pipeline:skip-release-note-categories 레이블을 추가하세요. 주목할 만한 기여자 추가 # Developer Relations는 각 릴리즈마다 주목할 만