<div id="readability-page-1" class="page">






<nav id="global-navigation">


</nav>
<main id="wrap" aria-hidden="false">

<div>






	
<article>
<header id="global-header">



<div>
<h2>모두 자동화해버리는 Github Actions!</h2>
<ul>
<li role="text" aria-label="2022년 03월 29일 22시 16분에 작성된 글."><time datetime="2022-03-29T22:16">2022.03.29 22:16</time></li>
<li><a href="/category/Git" aria-label="Git">Git</a></li>
</ul>
</div>


</header>
<div id="article">            <figure width="100%"><span data-url="https://blog.kakaocdn.net/dn/dPRZX6/btrxLlLU6xi/Bf7hLGYHp9h2rq121jBc4k/img.png" data-lightbox="lightbox" data-alt=""><img src="https://blog.kakaocdn.net/dn/dPRZX6/btrxLlLU6xi/Bf7hLGYHp9h2rq121jBc4k/img.png" width="100%"></span></figure>
<h2>Github Actions란?</h2>
<ul>
<li>Github에서 제공하는 저장소에서 소프트웨어 개발 <code>Workflow</code>를 자동화, 커스터마이징, 실행할 수 있는 서비스</li>
<li><code>Jenkins</code>를 이용했던 CI/CD를 포함하여 원하는 작업을 수행하기 위한 작업을 검색, 생성 및 공유 가능</li>
<li><code>Action</code>들을 결합해서 맞춤형 <code>Workflow</code> 생성 가능</li>
<li>기존에 <code>Jenkins</code>, <code>Lambda</code>를 이용했던 자동화 작업들을 OSS로 통합 가능</li>
<li>간단히하자면 Workflow 툴<ul>
<li>Build, Test, Deploy, Release Drafter, Labeler ... </li>
</ul>
</li>
<li>자세한 설명은 역시 <a href="https://docs.github.com/en/actions">Github Actions 공식문서</a> 참고</li>
</ul>
<h2>개념</h2>
<p>Github Action은 다음과 같은 개념들로 이루어져있습니다.</p>
<h3>Workflow</h3>
<ul>
<li>최상위 개념, <code>yaml</code>로 작성하는 파일의 단위</li>
<li><code>.github/workflows</code> 하위에 위치하면 저장소에서 자동으로 인식</li>
<li>단일 혹은 여러개의 <code>Job</code>으로 구성되어, 특정 <code>Event</code>에 트리거 될 수 있는 프로세스</li>
</ul>
<h3>Event</h3>
<ul>
<li><code>Workflow</code>를 실행하는 규칙</li>
</ul>
<h3>Job</h3>
<ul>
<li>가상 환경에서 실해되는 주체, 다른 <code>Job</code>과의 의존성을 가질 수 있고 병렬로도 실행가능</li>
<li><code>Jenkins</code>의 <code>Job</code>과 비슷한 개념</li>
</ul>
<h3>Step</h3>
<ul>
<li><code>Task</code>의 집합으로 <code>Command</code> 혹은 <code>Action</code>을 실행</li>
</ul>
<h3>Action</h3>
<ul>
<li><code>Workflow</code>의 가장 작은 단위</li>
<li>다른 사람들의 <code>Action</code>이 public으로 공개되어있다면, 이를 아무런 조건없이 사용할 수 있음</li>
<li><code>Job</code>과 <code>Step</code>을 연결할 수 있음</li>
</ul>
<h3>Runner</h3>
<ul>
<li>Github Action Runner App이 설치된 머신으로 Workflow가 실제로 실행될 인스턴스</li>
<li>Jenkins가 설치된 Server와 비슷한 개념</li>
<li>github-hosted runner와 Self-hosted runner로 구분<ul>
<li>github-hosted runner: 저장소에서 설치된 서버에 자동으로 설치되어 있는 runner</li>
<li>self-hosted runner: 사용자가 직접 설치한 서버에 자동으로 설치되어 있는 runner</li>
</ul>
</li>
</ul>
<h2>workflow 작성하기</h2>
<p>가장 간단한 형태인 Build Test를 위한 Workflow를 작성해보겠습니다.</p>
<pre><code>name: Build

on:
  # PR의 base 브렌치가 master, RB-**인 경우 해당 workflow를 실행합니다.
  pull_request:
    branches: [ master, RB-** ]

jobs:
  build:
    # 사용할 러너를 설정합니다.
    runs-on: [ self-hosted ]

    # 변수를 정의합니다.
    strategy:
      matrix:
        node-version: [ 14.17 ]

    steps:
      # 소스를 가져옵니다.
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          fetch-depth: 100

      # node-version에 해당하는 Node 세팅합니다.
      - name: Use Node.js
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}

      # 프로젝트를 build합니다.
      - name: Build
        run: |
          npm install -g yarn
          yarn install --prefer-offline --frozen-lockfile
          yarn build</code></pre>
<p>해당 코드를 <code>.github/workflows/build.yml</code> 파일로 저장하고, base 브렌치가 <code>master</code>혹은 <code>RB-**</code>인 PR이 올라오면 <code>Workflow</code>가 자동으로 실행됩니다. 위 코드에서 사용된 <code>actions/checkout@v2</code>, <code>actions/setup-node@v1</code>는 Github에서 제공하는 action들로 위와 같이 바로 사용할 수 있습니다.</p>
<h2>사용할만한 커스텀 Action</h2>
<ul>
<li><a href="https://github.com/marketplace/actions/release-drafter">Release Drafter</a> - 수정한 파일의 확장자, 브렌치명, PR 제목등에 따라 자동으로 라벨을 추가해주고 정해진 형식에따라 자동으로 릴리즈 초안을 작성해주는 Action</li>
<li><a href="https://github.com/marketplace/actions/auto-author-assign">Auto Author Assign</a> - PR을 올린 유저를 자동으로 해당 PR의 어사인에 추가해주는 Action</li>
<li><a href="https://github.com/marketplace/actions/merge-pull-requests-automerge-action">Merge pull requests</a> - 조건을 만족하면 PR을 자동으로 merge하는 Action</li>
</ul>
<h2>참고자료</h2>
<ul>
<li><a href="https://docs.github.com/en/actions">Github Actions 공식문서</a></li>
<li><a href="https://github.com/marketplace?category=&amp;query=&amp;type=actions&amp;verification">Github Actions Marketplace</a></li>
</ul>
            </div>




<nav>
<ul>
<li></li>
<li></li>
<li></li>
</ul>
</nav>





















</article>


</div>
</main>

<nav id="pagination">

</nav>









	



	            
            
            
                        
                                
        
</div>

빠리의 택시 운전사

Github Actions란?
Github에서 제공하는 저장소에서 소프트웨어 개발 Workflow를 자동화, 커스터마이징, 실행할 수 있는 서비스
Jenkins를 이용했던 CI/CD를 포함하여 원하는 작업을 수행하기 위한 작업을 검색, 생성 및 공유 가능
Action들을 결합해서 맞춤형 Workflow 생성 가능
기존에 Jenkins, Lambda를 이용했던 자동화 작업들을 OSS로 통합 가능
간단히하자면 Workflow 툴
Build, Test, Deploy, Release Drafter, Labeler ... 
자세한 설명은 역시 Github Actions 공식문서 참고
개념
Github Action은 다음과 같은 개념들로 이루어져있습니다.
Workflow
최상위 개념, yaml로 작성하는 파일의 단위
.github/workflows 하위에 위치하면 저장소에서 자동으로 인식
단일 혹은 여러개의 Job으로 구성되어, 특정 Event에 트리거 될 수 있는 프로세스
Event
Workflow를 실행하는 규칙
Job
가상 환경에서 실해되는 주체, 다른 Job과의 의존성을 가질 수 있고 병렬로도 실행가능
Jenkins의 Job과 비슷한 개념
Step
Task의 집합으로 Command 혹은 Action을 실행
Action
Workflow의 가장 작은 단위
다른 사람들의 Action이 public으로 공개되어있다면, 이를 아무런 조건없이 사용할 수 있음
Job과 Step을 연결할 수 있음
Runner
Github Action Runner App이 설치된 머신으로 Workflow가 실제로 실행될 인스턴스
Jenkins가 설치된 Server와 비슷한 개념
github-hosted runner와 Self-hosted runner로 구분
github-hosted runner: 저장소에서 설치된 서버에 자동으로 설치되어 있는 runner
self-hosted runner: 사용자가 직접 설치한 서버에 자동으로 설치되어 있는 runner
workflow 작성하기
가장 간단한 형태인 Build Test를 위한 Workflow를 작성해보겠습니다.
name: Build
on:
  # PR의 base 브렌치가 master, RB-**인 경우 해당 workflow를 실행합니다.
  pull_request:
    branches: [ master, RB-** ]
jobs:
  build:
    # 사용할 러너를 설정합니다.
    runs-on: [ self-hosted ]
    # 변수를 정의합니다.
    strategy:
      matrix:
        node-version: [ 14.17 ]
    steps:
      # 소스를 가져옵니다.
      - name: Checkout code
        uses: actions/checkout@v2
        with:
          fetch-depth: 100
      # node-version에 해당하는 Node 세팅합니다.
      - name: Use Node.js
        uses: actions/setup-node@v1
        with:
          node-version: ${{ matrix.node-version }}
      # 프로젝트를 build합니다.
      - name: Build
        run: |
          npm install -g yarn
          yarn install --prefer-offline --frozen-lockfile
          yarn build
해당 코드를 .github/workflows/build.yml 파일로 저장하고, base 브렌치가 master혹은 RB-**인 PR이 올라오면 Workflow가 자동으로 실행됩니다. 위 코드에서 사용된 actions/checkout@v2, actions/setup-node@v1는 Github에서 제공하는 action들로 위와 같이 바로 사용할 수 있습니다.
사용할만한 커스텀 Action
Release Drafter - 수정한 파일의 확장자, 브렌치명, PR 제목등에 따라 자동으로 라벨을 추가해주고 정해진 형식에따라 자동으로 릴리즈 초안을 작성해주는 Action
Auto Author Assign - PR을 올린 유저를 자동으로 해당 PR의 어사인에 추가해주는 Action
Merge pull requests - 조건을 만족하면 PR을 자동으로 merge하는 Action
참고자료
Github Actions 공식문서
Github Actions Marketplace

모두 자동화해버리는 Github Actions!

댓글