1️⃣ 워크플로 파일 작성하기

1
mkdir -p .github/workflows
2
touch .github/workflows/hello.yml

2️⃣ 워크플로 구문

1
name: Hello # 워크플로 이름
2
on: push # 푸시 이벤트가 발생할 때마다 워크플로 실행
3
jobs: # 해야할 일 정의
4
  hello: # 일의 ID
5
    runs-on: ubuntu-latest # 워크플로가 실행될 환경
6
    steps: # 일의 단계 정의
7
      - run: echo "Hello, World!" # 명령어 실행
8
      - uses: actions/checkout@v4 # 액션 호출

• name: Hello: 워크플로 명은 다음과 같이 name 키를 지정하며, 생략할 수도 있습니다. 단, 생략하면 워크플로 실행 로그를 분석하기 어려워지므로 항상 지정하도록 합시다.
• on: push: 워크플로 실행의 시작이 되는것이 이벤트입니다. 다음과 같이 on 키에 push, pull request를 지정할 수 있습니다. 그리고 on: [push, pull_request]처럼 배열을 지정해서 여러 개의 이벤트를 지정할 수도 있습니다.
• jobs: hello:: 잡은 워크플로의 실행단위입니다. 잡은 여러 개를 정의할 수 있으며 각각의 잡을 구분하기 위해서 잡의 ID를 설정합니다.
• runs-on: ubuntu-latest: 다음은 잡의 실행 환경인 러너다. runs-on 키 아래에 기술하게 된다. 말 그대로 잡을 실행할 환경을 지정한다.
• steps: run: echo "Hello, World!": 스텝은 워크플로의 최소 처리단위입니다. steps 키 아래에 기술하며 여러 개를 정의할 수 있습니다. 처리 순서는 위에서 아래 순서대로 진행됩니다.
• uses: actions/checkout@v4: uses 키에서는 액션을 호출합니다. 액션은 Github Actions에서 사용하는 모듈의 일정입니다. with 키를 사용하면 입력 파라미터도 지정할 수 있습니다. 예를 들어 with: ref: main 코드에는 입력파라미터 ref 에 main 이라는 값을 지정하고 있다.

TIP

1
- run: |
2
    git log -1
3
    tree -a .

위의 코드처럼 여러 줄의 스크립트도 구현할 수 있다.

2️⃣ 실행시킨 결과

다음과 같이 결과를 확인할 수 있습니다.

1️⃣ 워크플로 코드

1
name: Manual
2
on: # 수동 실행 이벤트
3
  workflow_dispatch: # 수동 실행 이벤트
4
    inputs:
5
      greeting: # 입력 파라미터명
6
        type: string # 데이터형
7
        default: Hello # 입력 파라미터의 기본값
8
        required: true # 입력 파라미터의 필수 플래그
9
        description: A cheerful word # 입력 파라미터의 개요
10
jobs:
11
  run:
12
    runs-on: ubuntu-latest
13
    steps:
14
      - run: echo "${{inputs.greeting}}" # 입력 파라미터의 greeting값 출력

2️⃣ 수동 실행 방법

1
gh workflow run manual.yml -f greeting=goodbye

위의 명령어를 실행하면, 아래의 결과가 나오는것을 확인할 수 있습니다. 여기서 -f는 입력 파라미터를 설정합니다.

3️⃣ 결과

1️⃣ 워크플로 코드

1
name: Schedule
2
on:
3
  schedule: # 정기 실행 이벤트
4
    - cron: '*/15 * * * *' # 매 시간 15분마다 실행하는 cron 식
5
jobs:
6
  run:
7
    runs-on: ubuntu-latest
8
    steps:
9
      - run: date

참고로 분 단위의 일시 지정이 가능하지만, 시간에 정확히 맞춰 실행되지 않을 수 있다. 따라서 정확한 시간을 요하는 처리에는 적합하지 않으며 하루에 여러 번 반복적으로 실행해야하는 처리에 알맞은 방식이다.

1️⃣ Github Host Runner

Github Host Runner는 깃허브가 제공하는 실행 환경이다. 귀찮은 운영은 Github가 담당하므로 편리하다는 이점이 있다. 또한 러너에는 여러가지 소프트웨어가 설치되어있기 때문에 더 편합니다. 참고로 표준 사양의 러너 외에도 Larger Runner라고 하는 러너도 존재합니다. 이 러너의 경우 유료이지만 머신 사양이 좋아서 잡을 실행하는 시간이 오래걸리는 경우 좋은 선택으로 불립니다.

2️⃣ Self Host Runner

사용자가 직접 실행 환경을 준비하는 것입니다. OS나 머신 사양을 자유롭게 설정할 수 있다는 점이 이점이며, 프라이빗 네트워크에서 운영하고 싶은 경우에도 적합합니다. 하지만, 러너를 직접 관리해야한다는 점이 단점으로 불립니다.

3️⃣ Supported OS