🚀 문서 페이지 배포

GitHub Actions를 이용한 자동 배포

문서 페이지는 .github/workflows/publish-github-pages.yml 파일에 정의된 GitHub Actions 워크플로우를 통해 자동으로 배포됩니다.

주요 기능

이 Workflow는 docs 앱의 빌드를 수행하고, 빌드된 결과물을 GitHub Pages에 배포합니다.

배포 URL

publish-github-pages 워크플로우 설정에 따라 GitHub Pages 로 배포된 문서 페이지는 https://USER_ID.github.io/PROJECT_NAME 형식의 URL로 접근할 수 있습니다.

주요 동작 설명

설정

• 트리거: main 브랜치에 push가 발생하면 워크플로우가 실행됩니다.
• 권한 설정: GitHub Pages에 배포할 수 있도록 필요한 권한을 부여합니다.

빌드

• 캐시 활용: node_modules, 빌드 결과물, turbo 캐시 등을 저장해 빌드 속도를 높입니다.
• 환경 변수 생성: Giscus(댓글 시스템) 관련 환경 변수를 자동으로 .env.local 파일로 생성합니다.
• 빌드: pnpm run build --filter=docs 명령어로 docs 앱을 빌드합니다.
• 아티팩트 업로드: actions/upload-pages-artifact@v3 액션을 사용해 빌드된 정적 파일(apps/docs/out)을 업로드합니다.

배포

• 배포: actions/deploy-pages@v4 액션을 사용해 GitHub Pages로 실제 배포가 이루어집니다.