GitHub Pages 배포¶

저장소에는 .github/workflows/docs.yml이 포함되어 있습니다. pull request에서는 문서와 site를 검증하고, main branch에 반영되면 GitHub Pages artifact를 게시합니다.

처음 한 번 필요한 설정¶

GitHub 저장소의 Settings → Pages로 이동합니다.
Build and deployment → Source를 GitHub Actions로 선택합니다.
Actions가 완료되면 https://hyunbin1.github.io/Backend-Engineering-Notes/에서 확인합니다.

private 저장소의 Pages 제공 범위는 GitHub plan과 조직 정책에 따라 다를 수 있습니다. Pages가 허용되지 않으면 workflow의 build 검증은 그대로 사용할 수 있고, 저장소 공개 또는 지원 plan을 선택한 뒤 같은 설정으로 게시할 수 있습니다.

배포 전에 자동으로 확인되는 것¶

README와 sidebar가 catalog와 일치하는지
링크와 필수 문서 구조가 유효한지
제외하기로 한 콘텐츠와 공개 금지 표현이 없는지
MkDocs strict build가 성공하는지