build - pages-build-deployment

[abarthdew]

deploy yml file

.github/workflows/gh-pages.yaml

• 배포에 필요한 명령어들을 작성한 파일.
• 참고에 나오는 것처럼, npm run build를 호출해 압축 파일들을 /dist에 수동으로 저장할 필요 없음.
• gitHub deploy시, 자동으로 gh-pages 브랜치가 생성되고 배포할 결과물이 저장된다.

[Settings] - choose deploy method

• 배포에는 두 가지 방법이 있음.
  1. git actions 사용, 2. git 브랜치로 배포(Deploy from a branch)
• 현재 프로젝트는 2. 방식 채택.
• 배포 결과물이 gh-pages에 저장되므로 배포 브랜치는 main이 아닌 gh-pages.
• 하지만, gh-pages 브랜치를 먼저 만들어 줘야 하므로 gh-pages.yml 파일을 push -> 파일 내용에 의해 Actions 탭에서 자동으로 deploy됨 -> gh-pages 브랜치 생성 및 배포 파일 자동 저장됨.

  

• 그 다음, Settings - Actions 탭에서 main으로 되어 있는 설정을 gh-pages로 바꿈.

  

[Actions] - check build & deploy

• 위 [Settings]에서 gh-pages 브랜치 설정 후, Actions 탭에서 다시 결과물이 배포됨.
• 그 외, 코드 수정 후 git push -> 배포 자동 실행 및 로그 확인 가능.

  

error: deploy

• permission write&read

  remote: Permission to NRCHKB/node-red-contrib-homekit-docker.git denied to github-actions[bot].
  fatal: unable to access 'https://github.com/NRCHKB/node-red-contrib-homekit-docker.git/': The requested URL returned error: 403
  Error: Invalid exit code: 128

  1. deploy yml file에 명령어로 넣는 방식, 2. 프로젝트 settings 에서 설정하는 방식 두 가지가 있음. 현재 프로젝트는 2. 방식 채택 Settings -> Actions -> general

• deploy is waiting for github-pages deployment approval

  deploy 상태가 waiting에서 안 넘어가길래 별짓을 다 해봤는데 알고 봤더니 gitHub 자체 업데이트 때문에 벌어진 일이었다. 앞으론 안 된다고 냅다 리포지토리 날리지 말고 gitHub Status 상태도 확인하자...

reference

[abarthdew]

workflow file.yaml example

jobs:
  # job의 이름 설정
  deploy:
    # 해당 job을 실행하는 운영 체제
    runs-on: ubuntu-latest

    # 수행할 동작 정의
    steps:
      # 1. 저장소 체크아웃
      - name: Checkout source code
        uses: actions/checkout@main

      # 2. node.js 환경설정
      - name: Set up Node.js
        uses: actions/setup-node@main
        with:
          node-version: 14.x

      # 3. 패키지 설치
      - name: Install dependencies
        run: npm install

      # 4. 테스트
      - name: Test unit
        run: npm run test:unit

      # 5. 빌드
      - name: Build Page
        run: npm run build
        env:
          NODE_ENV: production

      # 6. gh-pages로 배포
      - name: Deploy to gh-pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./dist

reference