[GitHub Actions] push 이벤트로 트리거 구성하기

GitHub Actions의 workflows는 소프트웨어 개발 과정에서 자동화된 작업을 정의합니다. 이를 통해 코드 푸시, 풀 요청 또는 다른 GitHub 이벤트에 반응하여 테스트, 빌드, 배포와 같은 CI/CD 작업을 실행할 수 있습니다.

GitHub Actions workflows에서 on 구문을 사용하여 이벤트를 트러거할 수 있습니다. 다양한 이벤트를 지원하며 특정 이벤트가 발생했을 때 자동으로 실행되어 CI/CD 자동화 작업을 구성할 수 있습니다. push 이벤트를 트리거하여 CI/CD 자동화 작업을 구성해보도록 하겠습니다.

개요

GitHub Actions의 on 구문은 workflows가 어떤 이벤트에 의해 트리거될 것인지를 정의하는 핵심 요소입니다.
이 구문을 통해 GitHub 리포지토리에서 발생하는 다양한 이벤트를 통해 자동화된 작업을 실행할 수 있습니다.
on 구문의 사용은 workflows의 유연성을 확장시켜 활용도 높게 사용할 수 있습니다.

on 구문 기본 구조

on: 
  [event_name]:
    [options]:

push 이벤트

GitHub Actions에서 push 이벤트는 가장 일반적으로 사용되는 트리거 중 하나입니다.

push 이벤트는 리포지토리에 커밋이 푸시될 때 발생합니다.workflows 파일에서 on: push 구문을 사용하면 특정 조건 하에 이 이벤트가 발생할 때마다 워크플로우가 실행되도록 설정할 수 있습니다.

기본 사용법

on: push

• 리포지토리의 어느 브랜치에든 커밋이 푸시될 때마다 workflows가 실행되도록 설정하였습니다.

브랜치 제한

on:
  push:
    branches:
      - main

• branches 옵션을 통해 main 브랜치에 푸시될 때만 workflows가 실행되도록 설정하였습니다.
• 복수의 브랜치를 지정하고 싶다면 브랜치 목록에 추가하면 됩니다.

on:
  push:
    branches-ignore:
      - 'dev'
      - 'experiment/*'

• branches-ignore 옵션을 통해 "dev" 브랜치와 "experiment/" 로 시작하는 모든 브랜치에 대한 푸시 이벤트를 무시하고 workflows 또한 실행되지 않도록 설정하였습니다.
• 이는 주로 안정적인 빌드나 배포 프로세스에 집중하고, 아직 개발 중이거나 실험적인 브랜치의 변경사항으로 인한 workflows 실행을 방지하고자 할 때 유용합니다.

branches 옵션과 branches-ignore 옵션을 동시에 사용하면 아래 오류가 발생합니다.

you may only define one of `branches` and `branches-ignore` for a single event

• branches 옵션과 branches-ignore 옵션은 동시에 사용할 수 없으며, 이 오류를 해결하기 위해서는 하나의 이벤트에 대해 branches 옵션 또는 branches-ignore 옵션을 사용해야 합니다.

태그 제한

on:
  push:
    tags:
      - 'v1.*'

• tags 옵션은 "v1." 이름으로 시작되는 모든 태그에 푸시될 때만 workflows가 실행되도록 설정하였습니다.
• 복수의 태그를 지정하고 싶다면 태그 목록에 추가하면 됩니다.

on:
  push:
    tags-ignore:
      - '*beta'

• tags-ignore 옵션은 branches-ignore 옵션과 유사하며 "beta" 로 끝나는 모든 태그에 대한 푸시 이벤트를 무시하고 workflows 또한 실행되지 않도록 설정하였습니다.

branches 옵션과 branches-ignore 옵션과 동일하게 tags 옵션과 tags-ignore 옵션을 같이 사용하면 아래 오류가 발생합니다.

you may only define one of `tags` and `tags-ignore` for a single event

• tags 옵션과 tags-ignore 옵션을 동시에 사용할 수 없으며, 이 오류를 해결하기 위해서는 하나의 이벤트에 대해 tags  옵션 또는 tags-ignore 옵션을 사용해야 합니다.

패턴을 사용한 제한

on:
  push:
    branches:
      - 'feature/*'
      - 'releases/**'
      - '!releases/**-test'
    tags:
      - 'v1.[0-9].[0-9]'

• "feature/" 로 시작하는 모든 브랜치 이름을 가진 브랜치에 푸시될 때 workflows가 실행되도록 설정하였습니다.
• "releases/" 아래의 모든 하위 브랜치 이름을 가진 브랜치에 푸시될 때 workflows가 실행되도록 설정하였습니다.
  • 하지만 "releases/" 하위 브랜치 중 "-test" 로 끝나는 브랜치는 제외합니다.
• "v1." 로 시작하고 그 다음에 숫자가 오는 태그(예: v1.0.0, v1.2.9, ...)에 대한 푸시 이벤트 발생 시 workflows가 실행되도록 설정하였습니다.
• branches-ignore 옵션와 tags-ignore 옵션에서도 패턴을 사용할 수 있습니다.
• 다양한 패턴을 통해 workflows를 구분하여 실행할 수 있습니다.

경로 및 파일 변경사항을 통한 제한

on:
  push:
    paths:
      - '**/*.js'

• paths 옵션은 설정한 파일이 변경될 경우에만 워크플로우가 실행하는 옵션입니다.
• ".js" 확장자를 가진 파일이 변경되어 푸시될 때만 워크플로우가 실행되도록 설정하였습니다.

on:
  push:
    paths-ignore:
      - 'docs/**'

• paths-ignore 옵션은 설정한 파일이 변경되면 워크플로우를 실행하지 않는 옵션입니다.
• "docs/" 디렉토리 내의 어떤 변경사항에도 워크플로우가 실행되지 않도록 설정하였습니다.

GitHub Actions의 on 구문과 push 옵션을 통해 push 이벤트 발생 시 workflows 실행되도록 설정해봤습니다.

GitHub Actions의 on 구문을 활용하면 리포지토리에서 발생하는 다양한 이벤트에 대응하여 workflows를 자동으로 실행할 수 있습니다. 특히, push 이벤트는 소프트웨어 개발 과정에서 매우 흔하게 발생하는 이벤트로, 이에 대해 workflows를 구성함으로써 코드의 푸시, 빌드, 테스트, 배포 등의 CI/CD 작업을 자동화할 수 있습니다.

branches, branches-ignore, tags, tags-ignore, paths, paths-ignore 등의 옵션을 사용하여 특정 조건에서만 workflows가 실행되도록 세밀하게 설정할 수 있습니다. 하지만 branches와 branches-ignore, tags와 tags-ignore는 각각 동시에 사용할 수 없으며, 이를 위반할 경우 오류가 발생함을 유의해야 합니다.

workflows의 다양한 옵션을 사용하여 workflows의 효율성과 유용성을 극대화하여 사용하시기 바랍니다.
지금까지 push 이벤트를 트리거하여 다양한 옵션을 통해 workflows를 실행해보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/ko/actions/using-workflows/events-that-trigger-workflows

[GitHub Actions] workflows 이름 설정하기

GitHub Actions의 workflows는 소프트웨어 개발 과정에서 자동화된 작업을 정의합니다. 이를 통해 코드 푸시, 풀 요청 또는 다른 GitHub 이벤트에 반응하여 테스트, 빌드, 배포와 같은 CI/CD 작업을 실행할 수 있습니다.

GitHub Actions의 하나의 작업을 workflows라고 정의하는데요. name 설정과 run-name 설정을 통해 workflows와 workflow runs 이름을 설정하여 사용할 수 있습니다. 해당 설정을 활용하여 workflows 이름을 설정해보도록 하겠습니다.

"name", "run-name" 미설정 시 기본 이름

GitHub Action을 통해 workflows 실행 시 기본적으로 설정되는 이름을 확인해봅시다.

예시 코드

run_name_demo.yml 이름의 workflow 파일을 생성하였으며 간단히 echo 명령어로 Text를 출력하도록 설정하였습니다. commit 메시지는 "[Action] Test run_name_demo"로 지정 후 push하여 workflows를 실행하도록 하였습니다.

> run_name_demo.yml

on: 
  push:

jobs:
  Jobs-Names-run_name_demo-01:
    runs-on: ubuntu-latest
    steps:
      - name: Echo Test
        run: echo "Run Workflows - run_name_demo"

실행 결과

workflows 이름 설정인 name 설정을 하지 않을 경우 생성되는 이름을 확인해보도록 하겠습니다.
workflows 이름은 파일 경로인 .github/workflows/run_name_demo.yml으로 생성되었습니다.
별도로 name 설정을 하지 않으면 workflows 이름은 파일 이름으로 생성되는 것을 확인하실 수 있습니다.

자 이제는 workflow runs 이름을 확인해보도록 하겠습니다.
run 이름은 commit 메시지인 [Action] Test run_name_demo으로 생성되었습니다.
별도로 run-name 설정을 하지 않으면 workflow runs 이름은 commit 메시지로 생성되는 것을 확인하실 수 있습니다.

"name", "run-name" 기본 설정

GitHub Action을 통해 workflows 실행 시 name, run-name 설정을 통해 이름을 설정해봅시다.

예시 코드

workflows 이름을 설정하기 위해 name, run-name 옵션을 사용하여 이름을 설정하였습니다.

> run_name_demo.yml

name: Workflows Names - run_name_demo
run-name: Runs Names - run_name_demo 🚀

on: 
  push:

jobs:
  Jobs-Names-run_name_demo-01:
    runs-on: ubuntu-latest
    steps:
      - name: Echo Test
        run: echo "Run Workflows - run_name_demo"

실행 결과

설정한 name 옵션으로 "Workflows Names - run_name_demo" 이름의 workflows가 생성되었습니다.

또한 설정한 run-name 옵션으로 "Runs Names - run_name_demo 🚀" 이름의 workflow runs이 생성되었습니다.

"name", "run-name" 설정 활용

GitHub Action의 name, run-name 설정을 활용해보도록 하겠습니다.

활용해볼 설정은 run-name 설정입니다. run-name 설정은 github과 inputs 컨텍스트를 사용하여 동적으로 구성할 수 있습니다.

예시 코드 및 실행 결과

이벤트 이름을 workflow runs 이름에 추가하기 위해 run-name 설정에 github 컨텍스트를 추가하였습니다.

run-name: Run_Names [ ${{ github.event_name }} ]

workflow runs 이름에 이벤트 이름을 확인하실 수 있습니다.

이번에는 branch 및 tag 정보를 추가해봤습니다.

run-name: Run_Names [ ${{ github.ref_type }} ]  [ ${{ github.ref_name }} ]

workflow runs 이름에 트리거된 branch 및 tag 타입과 이름을 확인하실 수 있습니다.

이번에는 workflows 실행자와 마지막 commit 시간 정보를 추가해봤습니다.

run-name: Run_Names [ ${{ github.actor }} ] [ ${{ github.event.head_commit.timestamp }} ]

workflow runs 이름에 workflows 실행자와 마지막 commit 시간을 확인하실 수 있습니다.

위 활용 방법과 같이 run-name 설정은 github과 inputs 컨텍스트를 사용하여 동적으로 구성할 수 있습니다.

다만 아쉬운 점은 github과 inputs 컨텍스트만 사용 할 수 있다는 점과 Job(작업)에서 활용된 변수나 결과에 따른 이름을 설정할 수 없다는 부분이 아쉽습니다. 또한 github과 inputs 컨텍스트를 사용한다고 해도 원하는 형식의 문자열로 변환하거나 출력할 수 없습니다. 이러한 부분이 아쉽지만 github 컨텍스트 정보에는 많은 정보가 있기 때문에 잘 활용할 경우 유용하게 사용할 수 있을 것 같습니다.

GitHub Actions의 name, run-name 설정을 통해 workflows 이름과 workflow runs 이름을 지정해봤습니다.

name 설정은 workflows 이름을 지정하며, GitHub 저장소의 "Actions" 탭에 표시됩니다.

run-name 설정은 workflow runs 탭에 표시되며 이벤트 이름, 브랜치 또는 태그 정보, 워크플로우 실행자, 마지막 커밋의 타임스탬프 등과 같은 동적 정보를 포함시킬 수 있습니다

GitHub Actions의 name 및 run-name 설정은 workflows와 workflows run을 명확하게 식별하고 조직화하는 데 매우 중요합니다. 이 설정들을 적절히 활용하면 workflows 관리의 효율성을 높일 수 있습니다. 특히 run-name 설정을 통해 workflow runs의 동적 이름을 구성함으로써, 각 실행의 세부 사항을 쉽게 파악하고 필요에 따라 신속하게 대응할 수 있습니다.

GitHub Actions를 사용할 때는 이러한 설정들을 적극적으로 활용하여 더욱 효과적인 워크플로우 관리를 해보시기 바랍니다. 지금까지 name 설정과 run-name 설정을 통해 workflows와 workflow runs 이름을 설정하여 사용해보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
https://docs.github.com/en/actions/learn-github-actions/contexts

[GitHub Actions] actions artifact 기능을 통한 데이터 공유 및 저장

GitHub Actions의 workflow는 소프트웨어 개발 과정에서 자동화된 작업을 정의합니다. 이를 통해 코드 푸시, 풀 요청 또는 다른 GitHub 이벤트에 반응하여 테스트, 빌드, 배포와 같은 CI/CD 작업을 실행할 수 있습니다.

GitHub Actions에는 CI/CD 작업을 위해 다양한 기능이 있으며 이번에 테스트할 기능은 actions/upload-artifact, actions/download-artifact 기능입니다. actions/upload-artifact, actions/download-artifact 기능은 workflow 동안 생성된 파일이나 디렉토리 등을 저장하고 활용할 수 있도록 해줍니다.

개요

GitHub Actions의 actions/upload-artifact는 workflow 실행 중에 생성된 파일이나 데이터를 GitHub에 업로드하여 저장하는 기능입니다. 이를 통해 작업이 끝난 후에도 데이터를 보존하고 사용할 수 있습니다.

actions/download-artifact는 저장된 아티팩트를 나중에 다운로드할 수 있게 해주어, 같은 workflow 내의 이후 작업에서 데이터를 사용하거나 공유할 수 있게 해줍니다.

이 두 기능을 통해 CI/CD 파이프라인에서 빌드 결과나 테스트 결과와 같은 중요한 데이터를 관리하고 전달할 수 있습니다.

- name: Upload Artifact text_dir
  uses: actions/upload-artifact@v4
  with:
    name: text_dir-artifact
    path: text_dir

- name: Download Artifact text_dir
  uses: actions/download-artifact@v4
  with:
    name: text_dir-artifact

사용 범위 및 제한 사항

사용 범위

• workflow가 생성한 파일이나 디렉토리를 아티팩트로 업로드하여, GitHub에서 호스팅하는 동안 해당 데이터를 보존합니다.
• 빌드 결과, 로그 파일, 테스트 결과, 바이너리 파일 등의 저장에 사용됩니다.
• 이미 업로드된 아티팩트를 다운로드하여 workflow가 완료된 후에도 아티팩트를 활용할 수 있습니다.

제한 사항

• 아티팩트의 기본 보관 기간은 90일입니다. 이 기간은 설정을 통해 조정할 수 있으나, 최대 90일로 제한됩니다.
• 저장 공간과 데이터 전송량은 GitHub Actions의 사용 한도에 포함되어 비용에 청구됩니다.
• workflow 실행 단위로 아티팩트를 관리하며, 이전 워크플로우 실행에서 생성된 아티팩트를 다운로드할 수는 없습니다.
• workflow 실행의 각 작업에는 아티팩트가 500개로 제한됩니다.

artifact vs cache 간단 비교

아티팩트와 캐싱은 GitHub에 파일을 저장하는 기능을 제공한다는 점에서 유사하지만 각 기능은 서로 다른 사용 사례를 제공하며 서로 바꿔서 사용할 수 없습니다.

• 패키지 관리 시스템의 빌드 종속성과 같이 작업이나 워크플로 실행 간에 자주 변경되지 않는 파일을 재사용하려는 경우 캐싱을 사용합니다.
• 워크플로 실행이 종료된 후 보기 위해 작업에서 생성된 파일(예: 빌드된 바이너리 또는 빌드 로그)을 저장하려는 경우 아티팩트를 사용합니다.

예시 코드

예시 코드의 workflow는 push 이벤트가 발생할 때마다 실행되도록 설정하였습니다. 또한 두 개의 작업(Job)을 구성하여 첫 번째 작업에서 파일을 저장하고, 두 번째 작업에서 저장 파일을 사용하도록 구성하였습니다.

actions/upload-artifact 코드

jobs:
  Jobs-Names-actions_artifact_demo-01:
    runs-on: ubuntu-latest
    steps:
      - name: Make text_dir
        run: mkdir text_dir

      - name: Create File
        run: touch text_dir/test-$(date "+%H%M%S")-01

      - name: Check File
        run: ls -al text_dir/*

      - name: Upload Artifact text_dir
        uses: actions/upload-artifact@v4
        with:
          name: text_dir-artifact
          path: text_dir/**
          retention-days: 5

mkdir 명령어와 touch 명령어를 통해 text_dir 디렉토리에 파일을 생성하였습니다.
생성한 파일은 actions/upload-artifact 기능을 통해 아티팩트로 저장하였습니다.
name 설정으로 저장되는 아티팩트 이름을 지정하고, path 설정으로 경로를 지정하였습니다.
retention-days 옵션은 아티팩트 보관 기간 설정이며 필수 설정은 아닙니다.

actions/download-artifact 코드

Jobs-Names-actions_artifact_demo-02:
  needs: Jobs-Names-actions_artifact_demo-01
  runs-on: ubuntu-latest
  steps:
    - name: Check File
      run: ls -al

    - name: Download Artifact text_dir
      uses: actions/download-artifact@v4
      with:
        name: text_dir-artifact
        path: text_dir

    - name: Check File
      run: ls -al text_dir/*

actions/upload-artifact 기능을 통해 저장된 아티팩트를 저장하였습니다.
name 설정으로 앞서 저장된 아티팩트의 이름을 지정하였으며, path 설정으로 다운받을 경로를 지정하였습니다.
path 설정이 없다면 기존 workspace 경로($GITHUB_WORKSPACE)에 저장되므로 특정 경로에 저장이 필요하다면 설정이 필요합니다.

실행

자 이제 예시 코드를 실행하여 actions/upload-artifact, actions/download-artifact 기능을 통한 데이터 저장 및 다운을 확인해보겠습니다.

설정한 workflow가 실행되었습니다.

01번 작업에서 mkdir 명령어와 touch 명령어를 통해 text_dir 디렉토리에 파일을 생성하였습니다.

01번 작업에서 actions/upload-artifact 기능을 통해 파일을 저장하였습니다.
저장시 아티팩트는 text_dir-artifact 이름으로 저장되었습니다.

자 이번에는 02번 작업에서 actions/download-artifact 기능을 통해 파일을 다운받아보도록 하겠습니다.
앞서 저장한 text_dir-artifact 이름의 아티팩트를 지정하였으며 text_dir 경로에 다운된 것을 확인하였습니다.

추가로 해당 workflow를 확인해보면 저장된 아티팩트를 GitHub에서 직접 다운로드 받을 수 있습니다.
저장 이름은 앞서 설정한 text_dir-artifact 이름으로 저장됩니다.

GitHub Actions의 actions/upload-artifact와 actions/download-artifact 기능을 통해 소프트웨어 개발 과정에서 생성된 데이터를 저장하고 공유할 수 있어, CI/CD 파이프라인의 효율성과 유연성이 크게 향상됩니다. 또한 빌드 결과, 로그 파일, 테스트 결과 등의 중요한 데이터를 쉽게 참조하고 이후 작업이나 다른 작업에서 활용할 수 있습니다.

그러나 아티팩트의 보관 기간, 저장 공간, 데이터 전송량에 대한 제한 사항이 있어 이를 고려해야 합니다. 실제 테스트에서는 actions/upload-artifact로 데이터를 업로드하고 actions/download-artifact로 다운로드하여 성공적으로 파일을 사용하는 것을 확인했습니다. 이러한 기능들은 다양하게 활용하여 CI/CD 자동화 시 효율성을 높여보시기 바랍니다.

지금까지 actions/upload-artifact와 actions/download-artifact 기능을 통해 workflow에서 생성한 데이터를 저장하고 공유해보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts

[GitHub Action] actions/cache 기능을 통한 데이터 캐싱

GitHub Action의 GitHub Actions의 workflow는 소프트웨어 개발 과정에서 자동화된 작업을 정의합니다. 이를 통해 코드 푸시, 풀 요청 또는 다른 GitHub 이벤트에 반응하여 테스트, 빌드, 배포와 같은 CI/CD 작업을 실행할 수 있습니다.

GitHub Actions에는 CI/CD 작업을 위해 다양한 기능이 있으며 이번에 테스트할 기능은 actions/cache 기능입니다. actions/cache 기능은 workflow 간에 파일을 캐싱하고 공유할 수 있습니다.

개요

GitHub Actions의 actions/cache는 workflow 간에 파일을 캐싱하여 실행 시간을 줄입니다. 사용자는 key와 path를 설정하여 캐시를 구성하며, 동일한 key가 있을 경우 기존 캐시를 재사용합니다. actions/cache 기능을 통해 의존성 다운로드, 빌드 결과 캐싱 등에 사용할 경우 유용합니다.

- name: Cache node modules
  uses: actions/cache@v2
  with:
    path: ~/.npm
    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
    restore-keys: |
      ${{ runner.os }}-node-

Cache Hit & Miss

GitHub Actions에서 actions/cache를 사용할 때, "Cache Hit"과 "Cache Miss"는 중요한 개념입니다.

• 캐시 히트(Cache Hit)
  • 요청한 key로 캐시가 이미 존재하면, 해당 캐시가 사용됩니다. 이 경우 새 캐시를 생성하지 않고, 기존 캐시를 사용하여 작업을 빠르게 진행할 수 있습니다.
• 캐시 미스(Cache Miss)
  • 요청한 key로 캐시가 존재하지 않으면, 새로운 캐시가 생성됩니다. 작업이 완료된 후, 지정된 path에 있는 파일들이 새 key와 함께 캐시됩니다.

actions/cache를 사용할 때, 적절한 key 전략을 수립하는 것이 중요합니다. 이미 존재하는 key 값으로 새로운 데이터를 캐싱할 경우 Cache Hit가 발생하며 새 캐시를 생성하지 않습니다.

따라서 새로운 데이터는 캐싱되지 않고 기존에 캐시한 데이터를 불러오도록 동작합니다. 그러므로 key는 고유한 값을 가지도록 파일의 해시값, 사용된 의존성 목록, 환경변수 등을 포함하여 구성됩니다. 이는 key의 고유성을 보장하고, 적절한 시점에 Cache Hit 또는 Miss를 발생시키는 데 사용될 수 있습니다.

Cache Hit은 성능을 최적화하는 반면, Cache Miss는 캐시를 최신 상태로 유지하고, 변경사항을 반영할 수 있는 기회를 제공합니다.

사용 범위 및 제한 사항

사용 범위

• 의존성 캐싱
  • node_modules, vendor/bundle, .pip 등과 같은 의존성 디렉터리를 캐시하여, 매번 의존성을 설치하는 시간을 절약할 수 있습니다.
• 빌드 캐싱
  • 빌드 과정에서 생성되는 아티팩트(예: 컴파일된 소스코드)를 캐시하여, 변경되지 않은 부분은 다시 빌드하지 않도록 할 수 있습니다.
• 테스트 캐싱
  • 테스트 데이터나 테스트 결과를 캐시하여, 변경되지 않은 테스트는 다시 실행하지 않을 수 있습니다.

제한 사항

• 캐시 크기 제한
  • GitHub Actions는 캐시의 최대 크기를 10GB로 제한하며, 이는 저장소 단위로 적용됩니다.
  • 대용량 파일을 캐시하려는 경우 이 제한에 주의해야 하며, 최대 캐시 스토리지에 도달하면 가장 오래된 캐시를 삭제하여 공간을 생성합니다.
• 캐시 유지 기간
  • 캐시된 데이터는 최대 7일간 유지됩니다. 7일이 지나면 캐시가 만료되고, 자동으로 삭제됩니다.
  • 장기간에 걸쳐 캐시를 유지하려는 경우에는 이를 고려하여 CI/CD 코드를 작성해야 됩니다.
• 캐시 공유 제한
  • 캐시는 동일한 GitHub Actions workflow 내에서만 공유됩니다.
  • 다른 저장소나 workflow 간에 캐시를 직접 공유할 수는 없습니다.

artifact vs cache 간단 비교

아티팩트와 캐싱은 GitHub에 파일을 저장하는 기능을 제공한다는 점에서 유사하지만 각 기능은 서로 다른 사용 사례를 제공하며 서로 바꿔서 사용할 수 없습니다.

패키지 관리 시스템의 빌드 종속성과 같이 작업이나 워크플로 실행 간에 자주 변경되지 않는 파일을 재사용하려는 경우 캐싱을 사용합니다.

워크플로 실행이 종료된 후 보기 위해 작업에서 생성된 파일(예: 빌드된 바이너리 또는 빌드 로그)을 저장하려는 경우 아티팩트를 사용합니다.

예시 코드

예시 코드의 workflow는 push 이벤트가 발생할 때마다 실행되도록 설정하였습니다. 또한 두 개의 작업(Job)을 구성하여 첫 번째 작업에서 파일을 캐싱하고, 두 번째 작업에서 캐싱된 파일을 복원하도록 구성하였습니다.

> ./.github/workflows/action_caching_demo.yml

name: Workflows Names - action_caching_demo
run-name: Runs Names - action_caching_demo 🚀
on: 
  push

jobs:
  Jobs-Names-action_caching_demo-01:
    runs-on: ubuntu-latest
    steps:
      - name: check all file
        run: ls -al 

      - name: create test file
        run: touch test_file

      - name: check create file
        run: ls -al 

      - name: caching file
        uses: actions/cache@v3
        with:
          path: test_file
          key: ${{ runner.os }}-test-${{ hashFiles('test_file') }}
          restore-keys: |
            ${{ runner.os }}-test-${{ hashFiles('test_file') }}
            ${{ runner.os }}-test-


  Jobs-Names-action_caching_demo-02:
    needs: Jobs-Names-action_caching_demo-01
    runs-on: ubuntu-latest
    steps:
      - name: check all file
        run: ls -al

      - name: caching file
        uses: actions/cache@v3
        with:
          path: test_file
          key: ${{ runner.os }}-test-${{ hashFiles('test_file') }}
          restore-keys: |
            ${{ runner.os }}-test-${{ hashFiles('test_file') }}
            ${{ runner.os }}-test-

      - name: check caching file
        run: ls -al

01번 작업에서 touch test_file 명령어를 사용하여 test_file이라는 새로운 파일을 생성 후 캐싱하고자 설정하였습니다.
02번 작업에서 캐싱된 파일을 복구하여 확인하도록 설정하였습니다.

캐싱 키는 실행 환경(OS)와 test_file의 해시 값을 기반으로 생성됩니다. 이는 key의 중복 없이 고유성을 보장하고자 설정하였습니다.

실행

자 이제 예시 코드를 실행하여 actions/cache 기능을 통한 데이터 캐싱을 확인해보겠습니다.

설정한 workflow를 실행하였습니다.

01번 작업에서 touch test_file 명령어를 사용하여 test_file이라는 새로운 파일을 생성하였습니다.

01번 작업에서 actions/cache 기능을 통해 test_file이라는 파일을 캐싱하였습니다. 요청한 key로 캐시가 존재하지 않아 Cache Miss가 발생하여 새 key와 함께 새로운 캐시를 생성하였습니다.

자 이번에는 02번 작업에서 actions/cache 기능을 통해test_file이라는 파일을 복구해보도록 하겠습니다. ls -al 명령어를 통해 파일이 없음을 확인하였으며, actions/cache 기능을 사용하였습니다. 요청한 key로 캐시를 확인하여 파일을 복구하였으며, 다시 ls -al 명령어를 통해 test_file 파일을 확인하였습니다.

GitHub Actions의 actions/cache 기능은 워크플로우의 실행 시간을 단축하고 성능을 최적화하기 위한 효율적인 도구입니다. 예시를 통해 test_file 생성 및 캐싱 과정을 통해, 동일한 key를 사용하여 캐시를 재사용하는 과정과 캐시 미스 시 새로운 캐시를 생성하는 방식을 확인하였습니다.

이는 의존성 설치, 빌드 과정의 최적화 및 테스트 데이터의 재사용 등 다양한 상황에서 유용하게 활용될 수 있습니다. 다만, 캐시 크기 제한 및 유지 기간과 같은 제한 사항을 고려하여 워크플로우를 설계해야 합니다.

GitHub Actions의 actions/cache 기능에 대한 이해에 도움이 되었다면 좋겠습니다.

또한 다양한 cache 설정을 통해 CI/CD 자동화 시 효율성을 높여보시기 바랍니다.

지금까지 actions/cache 기능을 통해 workflow 간에 파일을 캐싱하고 공유해보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows

[GitHub Action] workflow_call를 통한 다른 workflow 실행하기

GitHub Actions의 workflow는 소프트웨어 개발 과정에서 자동화된 작업을 정의합니다. 이를 통해 코드 푸시, 풀 요청 또는 다른 GitHub 이벤트에 반응하여 테스트, 빌드, 배포와 같은 CI/CD 작업을 실행할 수 있습니다.

GitHub Actions에는 CI/CD 작업을 위해 다양한 기능이 있으며 이번에 테스트할 기능은 workflow_call 기능입니다. workflow_call 기능은 다른 파일에 정의된 workflow를 실행할 수 있으며, 재사용이 가능합니다.

workflows_call 이벤트

workflow_call 이벤트를 사용하는 GitHub Actions workflow는 다른 workflow에서 재사용 가능한 구성 요소로 기능합니다. 이것은 코드 중복을 줄이고, 워크플로우의 유지 관리를 간소화하며, 프로젝트 전반에서 일관된 CI/CD 작업을 사용하는데 좋습니다.

• 예시 코드

  on:
  workflow_call:
    inputs:
      environment:
        required: true
        type: string

• on: workflow가 어떤 이벤트에 의해 활성화되는지 정의
• workflow_call: 다른 workflow에 의해 호출될 수 있음을 정의
• inputs: 호출하는 workflow에서 이 workflow로 전달할 수 있는 입력 파라미터 정의
• environment: 입력 파라미터 값(이름)
• required: true: 입력 파라미터 필수 제공 조건
• type: string: 입력 파라미터 형식

workflow_call:를 통해 외부에서 호출될 수 있음을 정의하고,

inputs:를 통해 다양한 입력 파라미터를 전달 받을 수 있습니다.

workflows_call 코드

workflows_call 이벤트를 통해 다른 workflows에서 workflows 파일을 실행할 경우 uses 키워드를 사용합니다. 호출하는 workflows를 call workflows라고 명칭하며 호출되는 called workflows라고 명칭하여 사용하는 것 같습니다.

호출되는 called workflow 코드

> ./.github/workflows/workflow_call.yml

name: Workflows Names - called_workflow
run-name: Runs Names - called_workflow 🚀

on:
  workflow_call:
    inputs:
      environment:
        required: true
        type: string

jobs:
  Jobs-Names-called_workflow:
    runs-on: ubuntu-latest
    steps:
      - name: echo enviroment
        run: echo Setup for ${{ inputs.environment }}

간단히 workflow 호출 시 입력 파라미터 environment 값을 받고 출력하도록 설정하였습니다.

호출하는 call workflow 코드

> ./.github/workflows/workflow_call_demo.yml

name: Workflows Names - workflow_call_demo
run-name: Runs Names - workflow_call_demo 🚀
on: 
  push

jobs:
  Jobs-Names-workflow_call_demo:
    uses: ./.github/workflows/workflow_call.yml
    with:
      environment: production

uses 키워드를 통해 재사용 workflows 파일의 경로를 지정하고 브랜치명 설정은 옵션이며 필요에 따라 지정합니다.

with 섹션을 통해 필요한 파라미터 inputs 값을 제공합니다.

 workflows_call 실행

Push 이벤트 및 수동으로 해당 workflow를 실행해보겠습니다.

설정한 workflow가 실행되었습니다.

workflow_call_demo.yml 파일이 실행되었으며

workflow_call 설정을 통해 environment 파라미터를 전달하여 workflow_call.yml 파일을 실행하였습니다.
전달한 파라미터 값(`production`)을 정상적으로 출력하였습니다.

GitHub의 workflow_call 이벤트를 활용하면 하나의 workflow를 다른 여러 workflow에서 재사용할 수 있어, 공통된 작업이 필요한 다양한 프로젝트나 레포지토리 간에 코드 중복을 줄이고 유지보수를 용이하게 할 수 있습니다. 또한 대규모 소프트웨어 개발 프로젝트에서 특히 유용할 수 있습니다. 공통된 작업을 재사용 코드로 관리하여 사용해보시기 바랍니다.


지금까지 workflow_call를 통한 다른 workflow를 실행 해보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/en/actions/using-workflows/reusing-workflows

[GitHub Actions] workflows 설정 및 기본 실행

GitHub Actions은 GitHub에서 호스팅되는 CI/CD 서비스로, 코드 이벤트에 반응하여 자동화된 워크플로우를 실행하여 빌드, 테스트, 배포 등의 작업을 자동으로 수행합니다. YAML 파일을 사용하여 간편하게 워크플로우를 정의하고 구성할 수 있습니다. YAML 파일을 통해 GitHub Actions의 workflows를 설정하여 push 이벤트 발생 시 자동으로 설정한 Pipeline이 동작되도록 기본적인 구성을 해보겠습니다.

workflows 기본 구조

workflows에 기본적인 구조를 알아봅시다.

GitHub Workflows 파일은 .github/workflows 디렉토리에 저장되며 YAML 형식을 사용하여 작성됩니다.
여기에는 기본적인 GitHub Workflows 파일의 구조가 있습니다.

### .github/workflows/github-actions-demo-01.yml

name: Workflow 이름
run-name: Workflow 실행 이름
on:
  event:
    - trigger 이벤트 (예: push, pull_request, release 등)

jobs:
  job_이름:
    runs-on: runner 환경 (예: ubuntu-latest, windows-latest, macos-latest 등)

    steps:
      - name: 단계 1
        uses: 사용할 액션 또는 스크립트
        with:
          key1: value1
          key2: value2

      - name: 단계 2
        run: 실행할 명령어 또는 스크립트

• name: 워크플로우 이름
• run-name: 워크플로우 실행 이름
• on: 어떤 이벤트에서 워크플로우가 실행될지 정의 / 예를 들어 push, pull_request, release 등이 있음
• jobs: 여러 단계로 구성된 작업들의 그룹
  • jobs_name: 작업 이름
  • runs-on: 작업이 실행될 환경
  • steps: 작업을 수행하는 단계
    • name: 단계 이름
    • uses: 사용할 액션 또는 스크립트 지정
    • with: 액션에 전달할 매개변수
    • run: 실행할 명령어나 스크립트 직접 지정

이 외에 다양한 기능과 옵션을 제공하므로, 필요에 따라 추가하여 사용합니다.

workflows(yml) 설정 및 실행

Push 이벤트가 발생하면 간단히 echo 명령어로 실행하도록 설정을 추가해보겠습니다.

### .github/workflows/github-actions-demo-01.yml

name: Test GitHub Action Demo-01
run-name: Run GitHub Actions-01 🚀
on: [push]

jobs:
  Test-GitHub-Action:
    runs-on: ubuntu-latest
    steps:
      - name: echo-01
        run: |
          echo "TEST ECHO-01"

위와 같이 YAML 파일 생성 후 GitHub 프로젝트에 Push 해보도록 하겠습니다.

YAML에서 설정한 "Test GitHub Action Demo-01" 이름으로 workflows가 생성되었으며, 실행 이름은 "Run GitHub Actions-01" 으로 생성되었습니다.

이제 workflows "Run GitHub Actions-01"을 선택해보겠습니다.

YAML에서 설정한 "Test-GitHub-Action" 이름의 작업이 생성되어 있음을 확인하실 수 있습니다.

또한 상세한 Pipeline을 확인해보실 수 있으며, 성공 여부, 동작 시간 등을 확인하실 수 있습니다.

이제 작업 "Test-GitHub-Action"을 선택해보겠습니다.

설정한 run 필드의 echo "TEST ECHO-01" 명령어가 입력되고 정상적으로 실행됨을 확인하실 수 있습니다.

정상적으로 실행이 완료되면 Action 설정에서 녹색 표시를 확인하실 수 있습니다.

2개의 workflows(yml) 설정 및 실행

2개의 workflows(yml)를 생성한다면 어떻게 동작되는지 테스트해보겠습니다.

이전에 테스트한 내용과 비슷한 내용으로 YML 파일을 생성해보겠습니다.

### .github/workflows/github-actions-demo-02.yml

name: Test GitHub Action Demo-02
run-name: Run GitHub Actions-02 🚀
on: [push]

jobs:
  Test-GitHub-Action:
    runs-on: ubuntu-latest
    steps:
      - name: echo-02
        run: |
          echo "TEST ECHO-02"

위와 같이 YAML 파일 생성 후 GitHub 프로젝트에 Push 해보도록 하겠습니다.

workflows 2개가 생성되며 각각의 작업이 실행됨을 확인하실 수 있습니다.

여러 개의 YAML 파일을 사용하여 GitHub Actions을 구성하는 주요 이유는 모듈성과 재사용성을 높이기 위함입니다.

큰 규모의 프로젝트 또는 복잡한 워크플로우를 다룰 때, 단일 YAML 파일에 모든 것을 포함하는 것은 유지 보수가 어렵고 코드의 가독성을 떨어뜨릴 수 있습니다. 따라서 이를 해결하기 위해 여러 개의 YAML 파일을 사용하는 것이 일반적입니다.

예를 들어, build.yml, test.yml, deploy.yml과 같이 역할이나 기능에 따라 나누어진 YAML 파일을 만들고, 이를 메인 워크플로우 파일에서 jobs 섹션에서 불러와 사용할 수도 있습니다.

지금까지 workflows 설정 후 기본 실행을 해보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/en/actions

[GitHub Actions] 한번 알아보자

GitHub Actions를 먼저 알아보기전 GitHub을 먼저 알아보자면, GitHub(깃허브)이란 소프트웨어 버전 관리와 협업을 위한 Git 플랫폼 입니다. 별도로 서버를 구성하지 않고도 GitHub 계정을 생성하여 소스 코드를 관리할 수 있습니다.

GitHub Actions이란 GitHub에서 공식적으로 제공하는 CI/CD 툴로써, 빌드, 테스트 및 배포 등의 파이프라인을 자동화할 수 있습니다. 또한 다양한 이벤트와 검색, 생성 및 공유 등 다양한 워크플로 및 사용자 정의된 워크플로를 사용할 수 있습니다. GitHub Actions의 특징 및 비용, 사용, 사례에 대한 기본적인 정보를 알아보겠습니다.

특징

GitHub Actions은 GitHub 저장소와 긴밀하게 통합되어 있어, 저장소 내에서 워크플로우를 설정하고 관리할 수 있습니다.
또한 코드, 이슈, 워크플로우 등 GitHub의 다양한 기능과 함께 통합되어 효과적인 협업과 개발이 가능합니다. 저장소 내에서 워크플로우를 설정하고 관리할 수 있다는 점이 큰 특징입니다.

GitHub에서 제공하는 Runner를 통해 별도의 서버(Runner)를 구성하지 않고 CI/CD Job을 실행할 수 있습니다.
Runner는 Windows, MacOS, Linux와 같은 다양한 운영체제에서 동작하며, 다양한 환경에서 실행할 수 있습니다.

병렬로 여러 워크플로우 작업을 처리할 수 있어, 대규모 프로젝트에서도 효율적으로 사용할 수 있습니다.

비용

기본적으로 한 달에 Job 실행에 대한 시간을 3,000분을 무료로 제공해줍니다.

운영 체제 및 CPU에 따른 분당 요금은 다르며 가장 기본적인 요금은 분당 $0.008 입니다.
대략적으로 하루에 1분이 소요되는 Job을 100번 실행한다면 한 달 요금이 $24정도 발생됩니다.

Job 실행 시간이 길거나 많은 수를 실행한다면 생각보다 높은 비용이 발생될 수 있습니다.

GitHub 비용 상세 정보 링크

사용

워크플로 파일을 GitHub 프로젝트의 ".github\workflows" 경로에 YAML 파일로 작성하면 됩니다.

작성 완료 후 속성을 부여하여 프로젝트에 푸쉬한다면 설정한 YAML 파일이 자동으로 동작합니다. 별도로 Runner를 설정하거나, GitHub 프로젝트의 옵션을 설정할 필요 없이 경로에 맞춰 파일을 생성하면 바로 동작합니다.

사례

다양한 기업에서 DevOps CI/CD 도구로 GitHub Action을 사용하고 계십니다.
몇 곳의 사레를 링크로 적어봤으며 참고하시기 바랍니다.

[뱅크 샐러드]
https://blog.banksalad.com/tech/become-an-organization-that-deploys-1000-times-a-day/

[다나와]
https://danawalab.github.io/common/2021/12/28/Github-Actions-%EC%82%AC%EC%9A%A9%EB%B2%95.html

[카카오엔터프라이즈]
https://tech.kakaoenterprise.com/180

GitHub Action과 다른 CI/CD 툴을 비교해봐도 큰 틀에서는 CI/CD 코드에 대한 형식과 기능은 비슷하지만 상세하게는 조금씩 다른 것 같습니다. 자신이 구성하고자 하는 환경과 효율, 비용 등을 고려하여 맞는 CI/CD 도구를 사용하시기 바랍니다.

지금까지 GitHub Action을 한번 알아보는 시간을 가졌습니다....! 끝...!

[Reference]
https://docs.github.com/en/actions