GitHub Actions 퀵스타트

GitHub Actions 퀵스타트

GitHub Actions의 핵심 기능을 몇 분 안에 직접 사용해 볼 수 있어요.

출처: Quickstart for GitHub Actions

본문

소개

GitHub Actions는 빌드, 테스트, 배포 파이프라인을 자동화할 수 있는 지속적 통합 및 지속적 전달(CI/CD) 플랫폼이에요. 리포지토리에 변경 사항을 푸시할 때마다 테스트를 실행하는 워크플로나, 병합된 풀 리퀘스트를 프로덕션에 배포하는 워크플로를 만들 수 있어요.

이 퀵스타트 가이드는 GitHub Actions의 핵심 기능 중 일부를 보여주는 워크플로를 GitHub 사용자 인터페이스로 추가하는 방법을 안내해요.

사전 구성된 워크플로로 시작하려면 actions/starter-workflows 리포지토리의 템플릿 목록을 살펴보세요. 자세한 내용은 워크플로 템플릿 사용하기를 참고하세요.

GitHub Actions 워크플로에 대한 개요는 워크플로를 참고하세요. GitHub Actions를 구성하는 다양한 구성 요소에 대해 배우고 싶다면 GitHub Actions 이해하기를 참고하세요.

워크플로 템플릿 사용하기

GitHub은 바로 사용하거나 커스터마이즈해 자체 워크플로를 만들 수 있는 사전 구성된 워크플로 템플릿을 제공해요. GitHub은 코드를 분석하고 리포지토리에 유용할 수 있는 워크플로 템플릿을 보여줘요. 예를 들어 리포지토리에 Node.js 코드가 있으면 Node.js 프로젝트용 제안이 표시돼요.

이 워크플로 템플릿은 빠르게 시작하고 실행하도록 설계되었으며, 다음과 같은 다양한 구성을 제공해요:

이 워크플로를 사용자 지정 워크플로를 만드는 시작점으로 사용하거나 그대로 사용할 수 있어요. actions/starter-workflows 리포지토리에서 워크플로 템플릿의 전체 목록을 찾아볼 수 있어요.

사전 요구사항

이 가이드는 다음을 가정해요:

  • GitHub 사용 방법에 대한 기본적인 지식이 있다는 것. 없다면 먼저 리포지토리와 풀 리퀘스트 문서의 일부 글을 읽는 것이 도움이 될 거예요. 예를 들어 리포지토리 퀵스타트, 분기, 풀 리퀘스트를 참고하세요.

  • 파일을 추가할 수 있는 GitHub 리포지토리가 있다는 것.

  • GitHub Actions에 접근할 수 있다는 것.

    [!NOTE] GitHub에서 리포지토리 이름 아래에 Actions 탭이 표시되지 않는다면 Actions가 리포지토리에서 비활성화되어 있기 때문일 수 있어요. 자세한 내용은 리포지토리의 GitHub Actions 설정 관리하기를 참고하세요.

첫 번째 워크플로 만들기

  1. GitHub의 리포지토리에서 .github/workflows 디렉토리에 github-actions-demo.yml이라는 워크플로 파일을 만드세요. 이렇게 하려면:

    • .github/workflows 디렉토리가 이미 존재한다면 GitHub에서 그 디렉토리로 이동해 Add file(파일 추가) 를 클릭하고 Create new file(새 파일 만들기) 을 클릭한 다음 파일 이름을 github-actions-demo.yml로 지정하세요.

    • 리포지토리에 .github/workflows 디렉토리가 없다면 GitHub에서 리포지토리 메인 페이지로 이동해 Add file(파일 추가) 을 클릭하고 Create new file(새 파일 만들기) 을 클릭한 다음 파일 이름을 .github/workflows/github-actions-demo.yml로 지정하세요. 이렇게 하면 .githubworkflows 디렉토리, 그리고 github-actions-demo.yml 파일이 한 번에 만들어져요.

    [!NOTE] GitHub이 리포지토리의 GitHub Actions 워크플로를 발견하려면 워크플로 파일을 .github/workflows라는 디렉토리에 저장해야 해요.

    워크플로 파일에는 원하는 이름을 붙일 수 있지만 파일 이름 확장자는 .yml 또는 .yaml을 사용해야 해요. YAML은 구성 파일에 흔히 사용되는 마크업 언어예요.

  2. 다음 YAML 내용을 github-actions-demo.yml 파일에 복사하세요:

    name: GitHub Actions Demo
    run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
    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@v6
          - 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 }}."
    

    이 시점에서는 이 워크플로의 세부 사항을 이해할 필요가 없어요. 지금은 내용을 파일에 복사·붙여넣기만 하면 돼요. 이 퀵스타트 가이드를 완료한 후 워크플로에서 워크플로 파일 문법에 대해 배울 수 있고, ${{ github.actor }}${{ github.event_name }} 같은 GitHub Actions 컨텍스트의 설명은 컨텍스트 참조를 참고하세요.

  3. Commit changes(변경 사항 커밋) 를 클릭하세요.

  4. "Propose changes(변경 제안)" 대화 상자에서 기본 분기에 커밋하는 옵션 또는 새 분기를 만들고 풀 리퀘스트를 시작하는 옵션 중 하나를 선택하세요. 그런 다음 Commit changes(변경 사항 커밋) 또는 Propose changes(변경 제안) 를 클릭하세요.

    언급된 영역이 주황색 윤곽선으로 강조된 "Propose changes" 대화 상자 스크린샷.

리포지토리의 분기에 워크플로 파일을 커밋하면 push 이벤트가 트리거되고 워크플로가 실행돼요.

풀 리퀘스트를 시작하기로 선택했다면 계속해서 풀 리퀘스트를 만들 수 있지만, 이 퀵스타트 목적에는 필요하지 않아요. 커밋이 여전히 분기에 만들어졌고 새 워크플로를 트리거하기 때문이에요.

워크플로 결과 보기

  1. GitHub에서 리포지토리 메인 페이지로 이동하세요.

  2. 리포지토리 이름 아래에서 Actions 를 클릭하세요.

    "github/docs" 리포지토리의 탭 스크린샷. "Actions" 탭이 주황색 윤곽선으로 강조됨.

  3. 왼쪽 사이드바에서 표시하려는 워크플로를 클릭하세요. 이 예시에서는 "GitHub Actions Demo"예요.

    "Actions" 페이지 스크린샷. 예시 워크플로 이름 "GitHub Actions Demo"가 진한 주황색 윤곽선으로 강조됨.

  4. 워크플로 실행 목록에서 보고 싶은 실행의 이름을 클릭하세요. 이 예시에서는 "USERNAME is testing out GitHub Actions"예요.

  5. 워크플로 실행 페이지의 왼쪽 사이드바에서 Jobs(작업) 아래의 Explore-GitHub-Actions 작업을 클릭하세요.

    "Workflow run" 페이지 스크린샷. 왼쪽 사이드바에서 "Explore-GitHub-Actions" 작업이 진한 주황색 윤곽선으로 강조됨.

  6. 로그에는 각 단계가 어떻게 처리되었는지 나와요. 단계를 펼쳐 상세 내용을 보세요.

    워크플로가 실행한 단계 스크린샷.

    예를 들어 리포지토리의 파일 목록을 볼 수 있어요:

    "List files in the repository" 단계가 펼쳐져 로그 출력을 보여주는 스크린샷. 단계 출력이 주황색 윤곽선으로 강조됨.

방금 추가한 예시 워크플로는 코드가 분기에 푸시될 때마다 트리거되며, GitHub Actions가 리포지토리의 내용과 어떻게 작동하는지 보여줘요. 심층 튜토리얼은 GitHub Actions 이해하기를 참고하세요.

다음 단계

GitHub Actions는 애플리케이션 개발 프로세스의 거의 모든 측면을 자동화하는 데 도움이 될 수 있어요. 시작할 준비가 되셨나요? GitHub Actions로 다음 단계를 밟는 데 도움이 되는 유용한 리소스는 다음과 같아요:

더 알아보기 (Learn more)