워크플로에서 변수 및 스크립트 구현

Completed

워크플로 파일의 구성 요소를 알고 있으므로 다양한 시나리오에 대해 이러한 워크플로를 사용자 지정하는 방법을 살펴볼 수 있습니다. 이 단원에서는 변수 및 스크립트를 사용하여 워크플로를 최적화하는 방법에 초점을 맞춥니다. 변수는 민감하지 않은 구성 정보를 저장하고 다시 사용하는 방법을 제공합니다. 컴파일러 플래그, 사용자 이름 또는 서버 이름과 같은 구성 데이터를 변수로 저장할 수 있습니다. 변수는 워크플로를 실행하는 실행기 컴퓨터에 보간됩니다. 작업 또는 워크플로 단계에서 실행되는 명령은 변수를 만들고 읽고 수정할 수 있습니다.

사용자 고유의 사용자 지정 변수를 설정하거나 GitHub에서 자동으로 설정하는 기본 환경 변수를 사용할 수 있습니다. 두 가지 방법으로 사용자 지정 변수를 만들 수 있습니다.

  • 단일 워크플로에서 사용할 환경 변수를 정의하려면 워크플로 파일에서 env 키를 사용할 수 있습니다.
  • 여러 워크플로에서 구성 변수를 정의하려면 조직, 리포지토리 또는 환경 수준에서 정의할 수 있습니다.

단일 워크플로에 대한 환경 변수 정의

단일 워크플로에 대한 사용자 지정 환경 변수를 설정하려면 워크플로 파일의 env 키를 사용하여 정의할 수 있습니다. 이 메서드에 의해 설정된 사용자 지정 변수의 범위는 정의된 요소로 제한됩니다. 다음에 대한 범위로 변수를 정의할 수 있습니다.

  • 워크플로 파일의 최상위 수준에서 env를 사용하여 전체 워크플로를 실행합니다.
  • jobs.<job_id>.env를 사용하여 워크플로 내의 작업 콘텐츠를 확인합니다.
  • jobs.<job_id>.steps[*].env를 사용하여 작업 내의 특정 단계를 지정합니다.

메모

jobs.<job_id>.env 및 jobs.<job_id>.steps[*].env 모두 이 모듈의 뒷부분에서 설명하는 컨텍스트를 구현하고 있습니다.

다음 워크플로 예제에서는 DAY_OF_WEEK 및 Greeting 두 개의 변수를 구현하여 실행 시 인사말을 생성합니다.

name: Greeting on variable day

on:
  workflow_dispatch

env:
  DAY_OF_WEEK: Monday

jobs:
  greeting_job:
    runs-on: ubuntu-latest
    env:
      Greeting: Hello
    steps:
      - name: "Say Hello"
        run: echo "$Greeting, today is $DAY_OF_WEEK!"

환경 변수에 대한 명명 규칙

환경 변수를 설정하는 경우 기본 환경 변수 이름을 사용할 수 없습니다. 이러한 기본 변수 중 하나의 값을 재정의하려고 하면 할당이 무시됩니다.

팁

기본 환경 변수의 전체 목록은 기본 환경 변수를 방문하세요.

리포지토리에 대한 구성 변수 만들기

개인 계정 리포지토리에 대한 GitHub에서 비밀 또는 변수를 만들려면 리포지토리 소유자여야 합니다. GitHub에서 조직 리포지토리에 대한 비밀 또는 변수를 만들려면 admin 액세스 권한이 있어야 합니다. 마지막으로 REST API를 통해 개인 계정 리포지토리 또는 조직 리포지토리에 대한 비밀 또는 변수를 만들려면 공동 작업자 액세스 권한이 있어야 합니다.

구성 변수 우선 순위

이름이 같은 변수가 여러 수준에 있으면 가장 낮은 수준의 변수가 우선합니다. 예를 들어 조직 수준 변수의 이름이 리포지토리 수준 변수와 같은 경우 리포지토리 수준 변수가 우선합니다. 마찬가지로 조직, 리포지토리 및 환경 모두 이름이 같은 변수가 있는 경우 환경 수준 변수가 우선합니다.

워크플로에 스크립트 추가

GitHub Actions 워크플로를 사용하여 스크립트 및 셸 명령을 실행한 다음 할당된 실행기에서 실행할 수 있습니다. 다음 예제에서는 run 키워드를 사용하여 실행기에서 명령 npm install -g bats 실행하는 방법을 보여 줍니다.

jobs:
  example-job:
    runs-on: ubuntu-latest
    steps:
      - run: npm install -g bats

리포지토리에 저장된 스크립트를 실행하려면 먼저 실행기에서 리포지토리를 체크 아웃해야 합니다. 다음 예제: 리포지토리를 체크 아웃합니다. 리포지토리의 스크립트 위치인 작업 디렉터리를 설정합니다. my-script.sh 스크립트를 실행합니다.

jobs:
  example-job:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./scripts
    steps:
      - name: Check out the repository to the runner
        uses: actions/checkout@v4  
      - name: Run a script
        run: ./my-script.sh

워크플로 작업을 실행하려는 모든 스크립트는 실행 가능해야 합니다. 스크립트를 실행하는 인터프리터(예: run: bash script.sh)에 인수로 전달하거나 파일 자체를 실행 가능하게 만들어 스크립트를 전달할 수 있습니다.