문제 개요

• Github Actions를 이용해 레포지토리에 push만 하면 자동으로 도커 이미지를 빌드하고 서버에 배포하는 CI/CD 파이프라인 구축
• 프로젝트가 마무리 되면서 README.md를 자주 수정
• 그 때마다 Github Actions의 워크플로우가 실행

README.md만 수정했는데 생성된 이미지

• 불필요한 Docker 이미지가 빌드되고 Docker Hub에 Push
• 서버의 컨테이너가 매번 재시작 되면서 리소스 낭비가 발생

원인 분석

name: CD Node.js Auth Server with docker

on:
  push:
    branches: ['dev']
  pull_request:
    branches: ['dev']

• 트리거가 단순히 dev 브랜치에 push하거나, PR 되었을 때 Github Actions 워크플로우가 실행되도록 설정
• README.md 변경은 배포와 관련이 없는데도 CI/CD 파이프라인이 계속 실행

해결

name: CD Node.js Auth Server with docker

on:
  push:
    branches: ['dev']
    paths-ignore:
      - '**/README.md'
  pull_request:
    branches: ['dev']
    paths-ignore:
      - '**/README.md'

• GitHub Actions의 paths-ignore 키워드를 사용
• 지정된 파일이나 디렉토리의 변경이 있을 때 워크플로우를 무시할 수 있는 키워드
• README.md가 변경될 경우에는 워크플로우가 실행되지 않도록 설정

결론

• README.md만 수정했을 때 Github Actions의 워크플로우가 실행되지 않는 것을 확인