<div id="readability-page-1" class="page"><div>GitHub Actions는 YAML로 events, jobs, 그리고 steps를 정의한다. 그리고 YAML 파일은 레포지토리의 <code>.github/workflows</code>에 저장된다. 이 YAML을 직접 작성하고 Actions를 실행 시켜보자.만들 예제는 npm으로 <a href="https://www.npmjs.com/package/bats">bats</a>를 설치하고 <code>bats -v</code>를 실행하는 간단한 액션이다. <h2 id="예제-만들기">예제 만들기</h2><h3 id="1-레포지토리-생성-및-yaml-파일-작성">1. 레포지토리 생성 및 YAML 파일 작성</h3>GitHub에서 레포지토리를 새로 만들고 <code>.github/workflows</code>에 YAML 파일을 작성한다.<figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/example_pic_1.png" alt=""><figcaption></figcaption></figure><div><pre><code data-lang="yaml"># https://docs.github.com/en/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow
name: learn-github-actions
on: [push]
jobs:
 check-bats-version:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v2
 - uses: actions/setup-node@v1
 - run: npm install -g bats
 - run: bats -v
</code></pre></div>편의상 GitHub에서 바로 작성 했다.<figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/example_pic_2.png" alt=""><figcaption></figcaption></figure> <h3 id="2-commit-후-push">2. commit 후 push</h3>작성한 YAML 파일을 push하자.<figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/example_pic_3.png" alt=""><figcaption></figcaption></figure><code>on: [push]</code> 구문(아래에서 자세히 알아보겠다)에 의해서 push를 하게 되면 actions이 실행 된다. <h3 id="3-actions-확인">3. Actions 확인</h3>GitHub에서 actions이 실행 되는 과정과 steps 별로 활동을 깔끔한 ui로 볼 수 있다.<figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/example_pic_4.png" alt=""><figcaption></figcaption></figure><figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/example_pic_5.png" alt=""><figcaption></figcaption></figure>사이드 바에서 jobs 별로 확인 할 수 있다.<figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/example_pic_6.png" alt=""><figcaption></figcaption></figure>간단하게 GitHub Actions를 만들어 보았다. 이제 YAML 파일에 작성한 코드들을 하나 씩 뜯어보자.<h2 id="yaml-파일workflow-파일-분석">YAML 파일(workflow 파일) 분석</h2><code>name:</code> =&gt; workflow의 이름. GitHub Actions 탭의 사이드바에서 확인 할 수 있다.<code>on:</code> =&gt; workflow 파일은 자동으로 실행시키는 이벤트를 정하는 코드다. push 말고도 <a href="https://docs.github.com/en/actions/reference/events-that-trigger-workflows#webhook-events">다양한 이벤트</a>를 세팅 할 수 있다. 더 나아가 <a href="https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths">branch, tags, path에 대해서 특정 할 수도 있다.</a><code>jobs:</code> =&gt; 모든 job들을 이 밑에 선언한다.<code>check-bats-version:</code> =&gt; job의 이름을 정의한다.<code>runs-on: ubuntu-latest</code> =&gt; job들이 Ubuntu linux runner(서버)에서 실행되게 명시 해줌을 의미한다. GitHub에서는 <a href="https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on">또 다른 운영체제</a>도 지원해주고 심지어 자기가 만든 runner도 명시 할 수 있다.<code>steps</code> =&gt; <code>check-bats-version</code> job이 실행할 step들을 이 밑에 선언한다.<code>- uses: actions/checkout@v2</code> =&gt; <code>uses</code> 키워드는 <code>actions/checkout</code>라는 이름을 가진 액션에서 <code>v2</code> 버전을 community action에서 가지고 오라고 job에게 요청하는 역할을 한다. <a href="https://github.com/marketplace/actions/checkout">actions/checkout@v2</a>은 레포지토리를 checkout하고 runner에 다운로드하여 코드를 실행하게 해주는 action이다. 그렇기 때문에 나의 레포지토리의 코드를 다루는 모든 workflow에서는 이 action을 사용해야 한다.<code>- uses: actions/setup-node@v1</code> =&gt; node 패키지를 runner에 설치해주는 action이다.<code>- run: npm install -g bats</code> =&gt; <code>run</code> 키워드는 runner에게 작성한 코드를 명령어로 실행하게 해준다.<code>- run: bats -v</code> =&gt; 명령어를 실행한다.정리하는 느낌으로 전체 과정을 이미지로 보고 넘어가자<figure><img loading="lazy" src="https://callmemaru.com/2021/GitHub-Actions-Learning-2/workflow-image.png" alt=""><figcaption></figcaption></figure><a href="/posts/github-actions-learning-3/" title="Next Post">다음 글</a>에서는 workflow 파일에서 변수를 사용하는 방법에 대해 알아보겠다.<hr>Reference<ul><li><a href="https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/introduction-to-github-actions#the-components-of-github-actions">Introduction to GitHub Actions</a></li></ul></div></div>

Call Me Maru

CHOI HEE JAE

GitHub Actions는 YAML로 events, jobs, 그리고 steps를 정의한다. 그리고 YAML 파일은 레포지토리의 .github/workflows에 저장된다. 이 YAML을 직접 작성하고 Actions를 실행 시켜보자.
만들 예제는 npm으로 bats를 설치하고 bats -v를 실행하는 간단한 액션이다.
 예제 만들기 1. 레포지토리 생성 및 YAML 파일 작성 GitHub에서 레포지토리를 새로 만들고 .github/workflows에 YAML 파일을 작성한다.
  
  # https://docs.github.com/en/actions/learn-github-actions/introduction-to-github-actions#create-an-example-workflow name: learn-github-actions on: [push] jobs: check-bats-version: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 - run: npm install -g bats - run: bats -v 편의상 GitHub에서 바로 작성 했다.

[GitHub Action Learning] #2 GitHub Actions 예제

댓글