[#50] PR 올렸을 때 Vercel Preview 배포

[cskime]

📝 작업 내용

• [#50] Vercel 배포 #58 에 이어서 Vercel 배포에 필요한 작업을 진행합니다.
• PR 생성 및 commit push 할 때마다 Vercel에 Preview 환경으로 배포하도록 설정합니다.
• PR을 만들고 코드 리뷰를 진행하는 중에 구현한 기능이 정상적으로 작동하는지 편리하게 확인할 수 있습니다.

👀 새로 알게 된 내용 (선택)

• Vercel은 3가지 환경으로 배포할 수 있습니다. (production, development, preview)
  • Production은 main branch를 tracking 하여 production ready 코드를 배포하는 것 같습니다.
  • Development는 develop branch를 tracking 하여 개발 중인 코드를 테스트하고 정상 동작을 확인하기 위한 배포에 사용하는 것 같습니다.
  • Preview는 그 외 모든 branch들에 대해 구현 결과를 확인하는 용도로 사용하는 것 같습니다.

💬 리뷰어에게 남길 말 (선택)

• 정상 동작하는지 테스트하기 위해 PR이 여러 번 생성 및 merge 될 수 있습니다.

[cskime]

이 작업은 현재 협업하는 구조에서는 아래와 같은 제약이 있어서 개발하지 않겠습니다.

• 이 PR에서는 PR이 생성되거나 PR에 새 commit이 push되면 해당 commit을 기준으로 GitHub Actions workflow를 실행해서 Vercel CLI를 통해 preview 환경으로 배포하는 작업을 진행했습니다.
• 이 때 Vercel token 등을 사용해야 하는데, 이런 값들은 보안상 노출되지 않아야 하므로 저장소의 secrets 변수로 등록해 두고 사용합니다.
• 그런데, GitHub은 forked repository에서 trigger된 workflow에서 secrets 변수에 접근할 수 없도록 제한하고 있으므로 Vercel에 배포하는 명령어에 token 값을 사용할 수 없습니다.
• 저장소를 fork하지 않고 하나의 저장소에서 다른 원격 branch를 만들어서 PR을 생성하는 방식으로 협업 방식을 바꾼다면 쉽게 가능하겠지만, 지금 시점에 협업 방식을 바꾸는 것은 무리일 것 같습니다.
• 자세한 내용이 궁금하시면 아래 블로그 글을 참고해보세요.
  • https://blog.outsider.ne.kr/1541
  • https://leeeeeyeon-dev.tistory.com/32
  • https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#using-secrets-in-a-workflow