[GitHub Actions] GitHub Actions 예제, Tutorials / Github Action 샘플

GitHub Actions을 사용하면 GitHub repository에 변화가 있을 때 특정 Jobs 들을 실행시킬 수 있습니다.

예를 들어 main branch 특정 파일이 Push 되거나 Merge 되었을 경우 repository의 해당 파일을 원격 저장소에 동기화하는 데 사용할 수 있습니다.

• 변화가 있을 때: Event가 감지되었을 때

 

아래는 공식 Documents의 소개 글 입니다.

Jenkins와 같은 3rd party 솔루션 없이도 GitHub Actions으로 CI/CD 파이프라인 구성이 가능합니다.

GitHub Actions
Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you'd like, including CI/CD, and combine actions in a completely customized workflow.

출처: https://docs.github.com/en/actions

 

이제 본론인 Github Actions 예제로 들어가 보겠습니다.

(GitHub Action example, github action example, git action, git actions, git action 예제, github actions 샘플)

 

공식 문서의 Quickstart 내용을 따라 했고 Actions 파일 생성, Push, Action 실행 확인 크게 3단계 과정으로 요약할 수 있습니다.

https://docs.github.com/en/actions/quickstart

Quickstart for GitHub Actions - GitHub Docs

 

Github Actions 예제 요약

1. Repository에 .github/workflows 디렉토리 생성 후 Github Actions 예제 파일 생성(.yml) 하기

2. Repository에 Push

3. GitHub Actions 실행 확인

 

 

1. Repository에 .github/workflows 디렉토리 생성 후 Github Actions 예제 파일 생성(.yml) 하기

GitHubs Actions를 적용할 Repository clone 및 디렉토리 생성

 

# GitHub Actions를 적용할 repository clone
git clone https://github.com/your-id/user-repository.git

# Github Actions를 위한 디렉토리 생성
cd user-repository
mkdir .github
mkdir .github/workflows

 

.github/workflows 디렉터리에 github-actions-demo.yml 파일 생성하기

• 예제파일은 .yml 포맷으로 이름, 실행 조건(on: [push]), 실행할 인스턴스 종류(run-on: ubuntu-latest), 실행할 작업들(steps: 총 10개가 순서대로 실행) 정보를 담고 있습니다.
• github-actions-demo.yml 파일 코드

 

name: GitHub Actions Demo
on: [push]
jobs:
  Explore-GitHub-Actions:
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
      - name: Check out repository code
        uses: actions/checkout@v3
      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
      - name: List files in the repository
        run: |
          ls ${{ github.workspace }}
      - run: echo "🍏 This job's status is ${{ job.status }}."

#출처: https://docs.github.com/en/actions/quickstart

 

디렉터리 및 파일 생성 결과

 

디렉터리 및 예제파일 생성 완료

 

샘플 repository 경로: https://github.com/menthamin/github-actions

GitHub - menthamin/github-actions: GitHub Actions Example

 

2. Repository에 Push

commit 및 push 명령어

# Commit 및 push
git add -A
git stats
git commit -m "add first github actions workflows"
git push

 

commit 및 push 결과

 

 

Commit 및 Push

3. GitHub Actions 확인

Github repository의 Actions 탭에서 Workflows를 확인할 수 있습니다.

아래 스크린샷을 보시면 GitHub Actions Demo라는 이름의 워크플로우가 실행된 것을 확인할 수 있습니다.

 

Workflow 실행 결과

 

위의 워크플로우를 클릭하면 Workflow의 상세 Jobs 실행 정보를 확인할 수 있습니다.

GitHub Actions 파일(.yml)에서 정의한 10개 Jobs이 순서대로 실행된 것을 볼 수 있습니다.

 

10개 Jobs 순서대로 실행 완료

 

이번 포스팅에서는 GitHub Actions 예제를 통해 간단한 github actions 사용 방법을 확인해 봤습니다.

다음번에는 github event 설정과 파일 동기화, 원격 명령어 실행(execute remote command)등을 올려 보겠습니다.

 

기타 궁금하신 사항은 편하게 댓글 남겨주세요.

 

감사합니다.

 

참고자료

1. GitHub Actions 공식 Docs, https://docs.github.com/en/actions/quickstart