매뉴얼웍스 6.0.18 버전부터 지원합니다.
브랜치(Branch)와 풀 리퀘스트(Pull Request)는 원본 장을 바로 수정하지 않고, 별도의 작업 공간에서 내용을 바꾼 뒤 검토를 거쳐 원본 장에 반영하기 위한 기능입니다.
브랜치는 특정 장을 기준으로 만드는 작업 공간입니다. 브랜치에서 내용을 수정해도 원본 장은 바로 바뀌지 않습니다. 풀 리퀘스트는 브랜치에서 작업한 내용을 원본 장에 반영해 달라고 요청하는 절차입니다.
브랜치와 풀 리퀘스트는 각각 하나의 장만 다룹니다. 브랜치와 풀 리퀘스트는 책과 짧은 문서에서 사용할 수 있습니다.
브랜치
브랜치는 원본 장을 복사해 만든 독립적인 작업 공간입니다. 브랜치에서는 일반 편집 화면과 같은 에디터로 다음 작업을 할 수 있습니다.
장 제목 수정
단락 내용 수정
단락 추가
단락 삭제
단락 이동
단락 유형, 사용자 정의 아이디, 옵션 변경
브랜치 목록에서는 브랜치 이름, 상태, 원본 장, 열린 풀 리퀘스트, 만든 사람, 생성 시간, 최종 변경 시간을 확인할 수 있습니다. 상태는 다음과 같이 표시됩니다.
상태 | 설명 |
|---|---|
DRAFT | 풀 리퀘스트를 만들기 전 작업 중인 브랜치입니다. |
OPEN_PR | 열린 풀 리퀘스트가 있는 브랜치입니다. |
MERGED | 풀 리퀘스트가 원본 장에 병합된 브랜치입니다. |
브랜치 만들기
다음 순서로 브랜치를 만듭니다.
문서 상세 화면에서 <1브랜치> 링크를 클릭합니다.
<2브랜치 만들기> 링크를 클릭합니다.
브랜치 이름을 입력합니다.
작업할 장을 선택합니다.
버튼을 클릭합니다.
브랜치를 만들면 선택한 장을 기준으로 별도의 작업 공간이 만들어집니다. 이 공간에서 수정한 내용은 풀 리퀘스트를 만들고 병합하기 전까지 원본 장에 반영되지 않습니다.
브랜치에서 작업하기
브랜치 이름을 클릭하면 브랜치 화면으로 이동합니다.
1<변경> 링크를 클릭해서 브랜치 이름을 바꿉니다.
2장 제목 링크를 클릭해서 선택한 장의 내용을 수정합니다. 일반 편집 화면과 같은 에디터를 사용합니다. 장 제목과 단락을 수정할 수 있으며, 필요한 경우 단락을 추가하거나 삭제하고 순서를 바꿀 수 있습니다.
브랜치에서 내용을 편집할 때는 내용 변경 알림 이벤트가 발생하지 않습니다. 대신 풀 리퀘스트를 만들거나 병합할 때 알림을 보냅니다.
변경 사항 확인하기
브랜치 화면에서 현재 브랜치와 원본 장 사이의 변경 사항을 확인할 수 있습니다.
변경 사항 화면은 원본과 브랜치의 차이를 전체 장 문맥 안에서 보여줍니다. 바뀐 단락만 따로 나열하지 않고 장 전체 내용을 보여주면서 변경된 부분을 표시합니다.
1<위로>와 <아래로> 링크를 사용하면 변경된 부분 사이를 이동할 수 있습니다. 각 변경 위치에서는 어떤 항목이 바뀌었는지 확인할 수 있습니다.
장 제목 변경
단락 내용 변경
단락 유형 변경
단락 사용자 정의 아이디 변경
단락 옵션 변경
단락 추가
단락 삭제
단락 이동
풀 리퀘스트
풀 리퀘스트는 브랜치의 변경 사항을 원본 장에 반영하기 위한 요청입니다. 검토자는 풀 리퀘스트 화면에서 변경 사항을 확인하고 병합하거나 닫을 수 있습니다.
풀 리퀘스트를 만들면 그 시점의 브랜치 내용이 검토 기준으로 저장됩니다. 이후 브랜치에서 추가로 수정한 내용은 이미 만들어진 풀 리퀘스트에 포함되지 않습니다.
풀 리퀘스트 목록에서는 풀 리퀘스트 제목, 브랜치, 상태, 원본 장, 만든 사람, 생성 시간, 최종 변경 시간을 확인할 수 있습니다.
상태는 다음과 같이 표시됩니다.
상태 | 설명 |
|---|---|
OPEN | 검토 또는 병합을 기다리는 풀 리퀘스트입니다. |
MERGED | 원본 장에 병합된 풀 리퀘스트입니다. |
CLOSED | 반영하지 않고 닫은 풀 리퀘스트입니다. |
풀 리퀘스트 만들기
브랜치 화면으로 이동합니다.
<풀 리퀘스트 만들기> 링크를 클릭합니다.
제목과 설명을 입력합니다.
저장합니다.
풀 리퀘스트가 만들어지면 브랜치는 OPEN_PR 상태가 됩니다. 이 상태에서는 같은 브랜치에서 다른 풀 리퀘스트를 만들 수 없습니다.
풀 리퀘스트를 만들 때 변경 사항이 없으면 풀 리퀘스트를 만들지 않습니다. 풀 리퀘스트를 만들면 모든 문서 소유자와 알림 수신을 허용한 문서 협업자에게 알림을 보냅니다.
풀 리퀘스트 검토하기
풀 리퀘스트 화면에서는 풀 리퀘스트를 만든 시점의 브랜치 스냅샷을 기준으로 변경 내용을 원본 장의 문맥 안에서 확인합니다. 브랜치 화면이 현재 브랜치 상태를 기준으로 변경 사항을 보여주는 것과 달리, 풀 리퀘스트 검토는 생성 시점에 고정된 내용을 대상으로 합니다.
검토자는 다음 내용을 확인합니다.
어떤 단락이 추가되었는지
어떤 단락이 삭제되었는지
어떤 단락이 이동되었는지
단락의 내용, 유형, 사용자 정의 아이디, 옵션이 어떻게 바뀌었는지
원본 장이 풀 리퀘스트 생성 이후 변경되어 충돌이 발생했는지
필요하면 댓글을 남겨 작업자와 의견을 주고받을 수 있습니다.
충돌 처리하기
풀 리퀘스트를 만든 뒤 원본 장이 바뀌면 충돌이 발생할 수 있습니다. 충돌이 발생한 단락은 검토 화면에서 별도로 확인합니다. 검토자는 단락별로 다음 중 하나를 선택합니다.
선택 | 설명 |
|---|---|
덮어쓰기 | 브랜치의 변경 내용을 원본 장에 반영합니다. |
무시 | 해당 단락의 브랜치 변경 내용을 버립니다. |
충돌이 있는 경우에는 필요한 항목을 선택한 뒤 병합합니다.
병합하기
병합은 풀 리퀘스트의 변경 내용을 원본 장에 반영하는 작업입니다. 문서 소유자만 풀 리퀘스트를 병합할 수 있습니다.
풀 리퀘스트 화면에서 변경 사항을 검토합니다.
충돌이 있으면 단락별 처리 방법을 선택합니다.
<병합> 링크를 클릭합니다.
병합이 완료되면 원본 장에 변경 사항이 반영됩니다.
병합할 때는 풀 리퀘스트를 만든 시점의 브랜치 스냅샷을 기준으로 반영합니다. 브랜치에서 작업한 이력 자체는 원본 장으로 가져오지 않습니다.
병합이 완료된 풀 리퀘스트는 기록으로 남습니다. 이미 병합된 풀 리퀘스트는 다시 병합할 수 없습니다. 병합이 완료되면 문서 소유자와 알림 수신을 허용한 문서 협업자에게 알림을 보냅니다.
닫기와 삭제
풀 리퀘스트를 원본 장에 반영하지 않으려면 풀 리퀘스트를 닫습니다. 문서 소유자와 풀 리퀘스트를 만든 사용자가 풀 리퀘스트를 닫을 수 있습니다. 풀 리퀘스트를 닫으면 관련 사용자에게 알림을 보냅니다.
열린 풀 리퀘스트가 있는 브랜치는 삭제할 수 없습니다. 풀 리퀘스트를 닫거나 병합한 뒤에는 브랜치를 삭제할 수 있습니다. 브랜치를 삭제해도 닫히거나 병합된 풀 리퀘스트 기록은 남습니다.
원본 문서를 삭제하면 해당 문서에서 만든 브랜치와 풀 리퀘스트도 함께 삭제됩니다.
사용 팁
브랜치는 작게 만드는 것이 좋습니다. 하나의 브랜치에는 한 가지 변경 주제만 담아야 검토와 병합이 쉽습니다.
풀 리퀘스트를 만들기 전에 브랜치 화면에서 변경 사항을 먼저 확인하세요. 단락 이동, 삭제, 옵션 변경처럼 눈에 잘 띄지 않는 변경도 함께 확인하는 것이 좋습니다.
원본 장이 자주 바뀐다면 풀 리퀘스트를 만든 뒤 오래 두지 말고 빠르게 검토하고 병합하는 것이 좋습니다.