CI/CD : github action no triggered when pushing to branch

 

[이전 글]2024.07.16 - [👩🏻‍💻 dev] - [ turborepo 설정] storybook Chromatic CLI 으로 배포하는 법

[ turborepo 설정] storybook Chromatic CLI 으로 배포하는 법

 

스토리북을 만들어서 chromatic CLI로 배포하는 작업을 했었다.

컴포넌트들을 만들려고 main <= 21-design-system <= #이슈번호-design-system-작업중인-컴포넌트 로 브랜치가 나뉘어져 있다.

작업중인 컴포넌트들을 하나씩 만들면 디자인 시스템에 합쳐주고 이를 메인에 합쳐주는 방식인데, 현재는 pr을 날리면 main과의 비교에서만 action이 동작하는 것이었다.

 

현재 action을 살펴보자.

name: "Chromatic Deployment"

on:
  pull_request:
    branches: [main, 21-design-system]
    paths:
      - packages/design-system/src/**

jobs:
  chromatic-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: ">=20"

      - name: Install pnpm
        uses: pnpm/action-setup@v2
        id: pnpm-install
        with:
          version: 9
          run_install: false

      - name: Get pnpm store directory
        id: pnpm-cache
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
      - name: Setup pnpm cache
        uses: actions/cache@v3
        with:
          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-
      - name: Install Dependency
        run: pnpm install -no-frozen-lockfile
        working-directory: packages/design-system

      - name: Publish Chromatic
        id: chromatic
        uses: chromaui/action@v1
        with:
          workingDir: apps/storybook
          projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
          token: ${{ secrets.SECRET_GITHUB }}

      - name: Create comment PR
        uses: thollander/actions-comment-pull-request@v1
        env:
          GITHUB_TOKEN: ${{ secrets.SECRET_GITHUB }}
        with:
          message: "🚀storybook: ${{ steps.chromatic.outputs.storybookUrl }}"

 

작성한 대로라면 21-design-system이나 main으로 pr을 날리면 chromatic으로 스토리북을 배포해주고, 해당 pr에 연달아 message인 "🚀storybook: ${{ steps.chromatic.outputs.storybookUrl }}"를 달아줄 거라 기대했지만,

결과는 계속 메인 #39를 비교하고 있는 pr #41에 코멘트가 달리고 있는 상황.

 

여러 설정들을 계속 건드려봤다.

현재 브랜치를 알아내는 step을 추가하거나, 현재 브랜치로 이슈 번호를 찾아서 그 번호에 코멘트가 달리도록 설정하거나...

근데 다 소용이 없었다.🥲

그러다 검색하다 다음 글에서 힌트를 얻었다.

I realized that this Github Actions file was on the main branch, and Github uses the actions that are configured for the branch that is getting pushed. It doesn't do anything if name-of-my-branch has different on: push: branches: specified in its .github/workflows/build_and_test.yml....

 

메인 브랜치의 .github에 워크 플로어가 있어서 깃허브는 해당 브랜치의 설정을 기준으로 actions가 동작한다는 것이다.

현재 작업 중인 브랜치에 위에서 작성했던 yml 파일을 생성해주니 잘 동작한다.

---

🍀 마치면서

의외로 간단하게 해결할 수 있었던 문제였다.
앞으로는 현재 github actions 브랜치가 설정 기준이라는 걸 염두하고 작성하도록 해야겠다.

📚 Reference

https://stackoverflow.com/questions/64565482/github-action-not-triggered-when-pushing-to-branch

Github Action not triggered when pushing to branch