변수 참조(Variables reference)

변수 참조(Variables reference)

GitHub Actions 워크플로에서 지원되는 변수, 명명 규칙, 한도, 컨텍스트에 대한 정보를 확인할 수 있어요. 워크플로를 구성할 때 변수 이름과 규칙을 찾아보기 좋은 참조 문서예요.

출처: 문서

본문

GitHub Actions 워크플로에서 지원되는 변수, 명명 규칙, 한도, 컨텍스트에 대한 정보를 확인할 수 있습니다.

이 문서는 GitHub Actions 워크플로에서 사용할 수 있는 지원 변수(환경 변수, 구성 변수, GitHub가 제공하는 기본 변수 포함)를 나열합니다. 워크플로를 구성할 때 변수 이름, 명명 규칙, 한도, 지원되는 컨텍스트를 조회할 때 이 참조를 사용하세요.

변수에 대한 자세한 내용은 Variables를 참고하세요.

기본 환경 변수

GitHub가 설정하는 기본 환경 변수는 워크플로의 모든 스텝에서 사용할 수 있습니다.

기본 환경 변수는 워크플로에서 정의되지 않고 GitHub가 설정하므로 env 컨텍스트로 접근할 수 없습니다. 그러나 대부분의 기본 변수에는 이름이 비슷한 해당 컨텍스트 속성이 있습니다. 예를 들어 GITHUB_REF 변수의 값은 워크플로 처리 중 ${{ github.ref }} 컨텍스트 속성으로 읽을 수 있습니다.

GITHUB_*와 RUNNER_*라는 기본 환경 변수의 값은 덮어쓸 수 없습니다. 현재 CI 변수의 값은 덮어쓸 수 있습니다. 그러나 이것이 항상 가능하리라는 보장은 없습니다. 환경 변수 설정에 대한 자세한 내용은 Store information in variables와 Workflow commands for GitHub Actions를 참고하세요.

액션은 하드코딩된 파일 경로 대신 변수를 사용해서 파일 시스템에 접근할 것을 강력히 권장합니다. GitHub는 액션이 모든 러너 환경에서 사용할 수 있도록 변수를 설정합니다.

[!NOTE] 잡 내에서 워크플로 실행 URL을 사용해야 한다면 다음 변수들을 결합할 수 있습니다: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID

구성 변수의 명명 규칙

구성 변수 이름에는 다음 규칙이 적용됩니다:

• 영숫자 문자([a-z], [A-Z], [0-9])나 밑줄(_)만 포함할 수 있습니다. 공백은 허용되지 않습니다.
• GITHUB_ 접두사로 시작하면 안 됩니다.
• 숫자로 시작하면 안 됩니다.
• 참조할 때 대소문자를 구분하지 않습니다. GitHub는 입력 방식과 관계없이 시크릿 이름을 대문자로 저장합니다.
• 시크릿이 생성된 저장소, 조직, 엔터프라이즈에서 고유해야 합니다.

환경 변수의 명명 규칙

환경 변수를 설정할 때 기본 환경 변수 이름 중 어느 것도 사용할 수 없습니다. 기본 환경 변수의 전체 목록은 아래 Variables reference를 참고하세요. 이러한 기본 변수 중 하나의 값을 재정의하려고 시도하면 할당이 무시됩니다.

[!NOTE] 스텝에서 run: env를 사용한 다음 스텝의 출력을 검사하면 워크플로 스텝에서 사용할 수 있는 환경 변수 전체 집합을 나열할 수 있습니다.

구성 변수 우선순위

같은 이름의 변수가 여러 레벨에 존재하면 가장 낮은 레벨의 변수가 우선합니다. 예를 들어 조직 레벨 변수와 저장소 레벨 변수의 이름이 같다면 저장소 레벨 변수가 우선합니다. 마찬가지로 조직, 저장소, 환경 모두에 같은 이름의 변수가 있으면 환경 레벨 변수가 우선합니다.

[!NOTE] 환경 레벨 변수는 잡이 실행을 시작한 후에만 러너에서 사용할 수 있습니다. 즉 환경 레벨 변수는 env와 vars 컨텍스트의 변수를 덮어쓰지 않습니다.

재사용 가능한 워크플로의 경우 호출자 워크플로 저장소의 변수가 사용됩니다. 호출되는 워크플로가 포함된 저장소의 변수는 호출자 워크플로에 제공되지 않습니다.

구성 변수의 한도

개별 변수는 크기가 48KB로 제한됩니다.

조직 변수 최대 1,000개, 저장소당 변수 500개, 환경당 변수 100개를 저장할 수 있습니다. 조직 및 저장소 변수의 총 결합 크기 한도는 워크플로 실행당 256KB입니다.

저장소에서 생성된 워크플로는 다음 수의 변수에 접근할 수 있습니다:

• 저장소 변수의 총 크기가 256KB보다 작으면 최대 500개의 저장소 변수. 저장소 변수의 총 크기가 256KB를 초과하면 한도 아래에 해당하는 저장소 변수만 사용할 수 있습니다(변수 이름 알파벳순 정렬).
• 저장소 및 조직 변수의 총 결합 크기가 256KB보다 작으면 최대 1,000개의 조직 변수. 조직 및 저장소 변수의 총 결합 크기가 256KB를 초과하면 해당 한도 아래에 해당하는 조직 변수만 사용할 수 있습니다(저장소 변수를 고려한 후 변수 이름 알파벳순 정렬).
• 환경 레벨 변수 최대 100개.

[!NOTE] 환경 레벨 변수는 256KB 총 크기 한도에 포함되지 않습니다. 저장소 및 조직 변수의 결합 크기 한도를 초과했고 추가 변수가 여전히 필요하다면 환경을 사용해서 환경에 추가 변수를 정의할 수 있습니다.

지원되는 컨텍스트

잡이 러너로 전송되기 전에 처리되는 워크플로 부분에서 변수 값에 접근하려면 일반적으로 env 또는 github 컨텍스트를 사용합니다.

[!WARNING] github 컨텍스트를 로그에 출력하지 마세요. 민감한 정보가 포함되어 있습니다.

더 알아보기 (Learn more)

• Variables
• Store information in variables
• Contexts reference