메타데이터 구문 참조

참고

Docker 컨테이너, JavaScript 및 복합 작업을 빌드할 수 있습니다. 작업에는 작업의 입력, 출력, 실행 구성을 정의하는 메타데이터 파일이 필요합니다. 작업 메타데이터 파일은 YAML 구문을 사용하며, 메타데이터 파일 이름은 action.yml 또는 action.yaml여야 합니다. 기본 설정 형식은 action.yml입니다.

`name`

          **필수** 작업의 이름입니다. GitHub은(는) 각 작업을 시각적으로 식별하는 데 도움이 되도록 `name` 탭에 **** 을 표시합니다.

`author`

          **선택 사항** 작업 작성자의 이름입니다.

`description`

          **필수** 다음은 작업에 대한 간단한 설명입니다.

`inputs`

          **선택 사항** 입력 매개 변수를 사용하면 런타임 중에 작업에서 사용할 데이터를 지정할 수 있습니다. GitHub은(는) 입력 매개 변수를 환경 변수로 저장합니다. 소문자 입력 ID를 사용하는 것이 좋습니다.

예: 입력 지정

이 예에서는 두 개의 입력을 구성합니다: num-octocats과 octocat-eye-color입니다. num-octocats 입력은 필수가 아니며 기본값은 1입니다. octocat-eye-color은 필수 입력이며 기본값이 없습니다.

참고

          `required: true`를 사용하는 작업은 입력이 지정되지 않은 경우 자동으로 오류를 반환하지 않습니다.

이 작업을 사용하는 워크플로 파일은 with 키워드를 사용하여 octocat-eye-color에 대한 입력 값을 설정할 수 있습니다. with 구문에 대한 자세한 내용은 GitHub Actions에 대한 워크플로 구문을(를) 참조하세요.

inputs:
  num-octocats:
    description: 'Number of Octocats'
    required: false
    default: '1'
  octocat-eye-color:
    description: 'Eye color of the Octocats'
    required: true

입력값을 지정하면 GitHub은(는) 이름이 INPUT_<VARIABLE_NAME>인 입력에 대한 환경 변수를 만듭니다. 만들어진 환경 변수는 입력 이름을 대문자로 변환하고 공백을 _ 문자로 바꿉니다.

          [복합체](/actions/creating-actions/creating-a-composite-action)를 사용하여 작업이 작성된 경우, 자동으로 `INPUT_<VARIABLE_NAME>`을 가져오지 않습니다. 복합 작업을 사용하면 `inputs`[AUTOTITLE](/actions/learn-github-actions/contexts)을 사용하여 작업 입력에 액세스할 수 있습니다.

Docker 컨테이너 작업에서 환경 변수에 액세스하려면 작업 메타데이터 파일에서 args 키워드를 사용하여 입력을 전달해야 합니다. Docker 컨테이너 작업의 작업 메타데이터 파일에 대한 자세한 내용은 Docker 컨테이너 작업 만들기을(를) 참조하세요.

예를 들어 워크플로가 num-octocats 및 octocat-eye-color 입력을 정의한 경우 작업 코드는 INPUT_NUM-OCTOCATS 및 INPUT_OCTOCAT-EYE-COLOR 환경 변수를 사용하여 입력 값을 읽을 수 있습니다.

`inputs.<input_id>`

          **필수** 입력과 연결할 `string` 식별자입니다. 
          `<input_id>` 값은 입력 메타데이터의 맵입니다. 
          `<input_id>`은 `inputs` 개체 내에서 고유한 식별자여야 합니다. 
          `<input_id>`는 문자 또는 `_`로 시작해야 하며 영숫자, `-` 또는 `_`만 포함해야 합니다.

`inputs.<input_id>.description`

          **필수** 입력 매개 변수에 대한 `string` 설명입니다.

`inputs.<input_id>.required`

          **선택 사항** 작업에 입력 매개 변수가 필요한지 여부를 나타내는 `boolean`입니다. 매개 변수가 필요한 경우 `true`로 설정합니다.

`inputs.<input_id>.default`

          **선택 사항** 기본값을 나타내는 `string`입니다. 기본값은 입력 매개 변수가 워크플로 파일에 지정되지 않은 경우에 사용됩니다.

`inputs.<input_id>.deprecationMessage`

          **선택 사항** 입력 매개 변수를 사용하면 `string`이 경고 메시지로 기록됩니다. 이 경고를 사용하여 입력이 닫기임을 알리고 대안을 언급할 수 있습니다.

Docker 컨테이너 및 JavaScript 작업의 `outputs`

          **선택 사항** 출력 매개 변수를 사용하면 작업이 설정하는 데이터를 선언할 수 있습니다. 워크플로에서 나중에 실행되는 작업은 이전에 실행한 작업의 출력 데이터 세트를 사용할 수 있습니다. 예를 들어 두 개의 입력(x + y = z)을 추가하는 작업을 수행하는 경우 이 작업은 입력으로 사용할 다른 작업에 대한 합계(z)를 출력할 수 있습니다.

작업당 출력 크기는 최대 1MB입니다. 워크플로 실행의 모든 출력 합계는 최대 50MB가 될 수 있습니다. 크기는 UTF-16 인코딩을 기준으로 추정됩니다.

작업 메타데이터 파일에서 출력을 선언하지 않은 경우에도 출력을 설정하고 워크플로에서 사용할 수 있습니다. 액션의 출력 설정에 대한 자세한 내용은 GitHub Actions에 대한 워크플로 명령을(를) 참조하세요.

예: Docker 컨테이너 및 JavaScript 작업에 대한 출력 선언

outputs:
  sum: # id of the output
    description: 'The sum of the inputs'

`outputs.<output_id>`

          **필수** 출력과 연결할 `string` 식별자입니다. 
          `<output_id>` 값은 출력 메타데이터의 맵입니다. 
          `<output_id>`은 `outputs` 개체 내에서 고유한 식별자여야 합니다. 
          `<output_id>`는 문자 또는 `_`로 시작해야 하며 영숫자, `-` 또는 `_`만 포함해야 합니다.

`outputs.<output_id>.description`

          **필수** 출력 매개 변수에 대한 `string` 설명입니다.

복합 작업을 위한 `outputs`

          **선택 사항**`outputs`은 `outputs.<output_id>` 및 `outputs.<output_id>.description`와 동일한 매개 변수를 사용하지만([`outputs`Docker 컨테이너 및 JavaScript 작업에 대한 ](#outputs-for-docker-container-and-javascript-actions) 참조) `value` 토큰도 포함되어 있습니다.

작업당 출력 크기는 최대 1MB입니다. 워크플로 실행의 모든 출력 합계는 최대 50MB가 될 수 있습니다. 크기는 UTF-16 인코딩을 기준으로 추정됩니다.

예: 복합 작업에 대한 출력 선언

outputs:
  random-number:
    description: "Random number"
    value: ${{ steps.random-number-generator.outputs.random-id }}
runs:
  using: "composite"
  steps:
    - id: random-number-generator
      run: echo "random-id=$(echo $RANDOM)" >> $GITHUB_OUTPUT
      shell: bash

`outputs.<output_id>.value`

          **필수** 출력 매개 변수가 매핑될 값입니다. 
          `string` 또는 컨텍스트가 있는 식으로 설정할 수 있습니다. 예를 들어 `steps` 컨텍스트를 사용하여 출력의 `value`를 단계의 출력 값으로 설정할 수 있습니다.

컨텍스트 구문을 사용하는 방법에 대한 자세한 내용은 문맥 참조을(를) 참조하세요.

`runs`

          **필수** JavaScript 작업, 복합 작업 또는 Docker 컨테이너 작업인지와 작업 실행 방식을 지정합니다.

JavaScript 작업용 `runs`

          **필수** 작업 코드의 경로와 코드를 실행하는 데 사용되는 런타임을 구성합니다.

예시: Node.js v24 사용

runs:
  using: 'node24'
  main: 'main.js'

JavaScript 작업용 `runs.using`

          **필수**[`main`](#runsmain)에 지정된 코드를 실행하는 데 사용되는 런타임입니다.

Node.js v20에는 node20을 사용합니다.
Node.js v24에는 node24를 사용합니다.

`runs.main`

          **필수** 작업 코드가 포함된 파일입니다. 
          [
          `using`
          ](#runsusing-for-javascript-actions)에 지정된 런타임은 이 파일을 실행합니다.

`runs.pre`

          **선택 사항**`main:` 작업이 시작되기 전에 작업 시작 시 스크립트를 실행할 수 있습니다. 예를 들어 `pre:`를 사용하여 필수 조건 설정 스크립트를 실행할 수 있습니다. 
          [
          `using`
          ](#runsusing-for-javascript-actions) 구문으로 지정된 런타임은 이 파일을 실행합니다. 
          `pre:` 작업은 기본적으로 항상 실행되지만 [`runs.pre-if`](#runspre-if)를 사용하여 이를 재정의할 수 있습니다.

참고

          `runs.pre`는 로컬 작업에 대해 지원되지 않습니다.

이 예제에서 pre: 작업은 setup.js라는 스크립트를 실행합니다.

runs:
  using: 'node24'
  pre: 'setup.js'
  main: 'index.js'
  post: 'cleanup.js'

`runs.pre-if`

          **선택 사항**`pre:` 작업 실행을 위한 조건을 정의할 수 있습니다. 
          `pre:` 작업은 `pre-if`의 조건이 충족되는 경우에만 실행됩니다. 설정하지 않으면 `pre-if`의 기본값은 `always()`입니다. 
          `pre-if`에서 상태 검사 함수는 작업 자체의 상태가 아니라 동작의 상태를 기준으로 평가합니다.

아직 실행된 단계가 없으므로 step 컨텍스트를 사용할 수 없습니다.

이 예제에서는 cleanup.js는 Linux 기반 실행기에서만 실행됩니다.

  pre: 'cleanup.js'
  pre-if: runner.os == 'linux'

`runs.post`

          **선택 사항**`main:` 동작이 완료된 후 작업이 끝날 때 스크립트를 실행할 수 있습니다. 예를 들어 `post:`을 사용하여 특정 프로세스를 종료하거나 필요하지 않은 파일을 제거할 수 있습니다. 
          [
          `using`
          ](#runsusing-for-javascript-actions) 구문으로 지정된 런타임은 이 파일을 실행합니다.

이 예제에서 post: 작업은 cleanup.js라는 스크립트를 실행합니다.

runs:
  using: 'node24'
  main: 'index.js'
  post: 'cleanup.js'

          `post:` 작업은 기본적으로 항상 실행되지만 `post-if`를 사용하여 이를 재정의할 수 있습니다.

`runs.post-if`

          **선택 사항**`post:` 작업 실행을 위한 조건을 정의할 수 있습니다. 
          `post:` 작업은 `post-if`의 조건이 충족되는 경우에만 실행됩니다. 설정하지 않으면 `post-if`의 기본값은 `always()`입니다. 
          `post-if`에서 상태 검사 함수는 작업 자체의 상태가 아니라 동작의 상태를 기준으로 평가합니다.

예를 들어 cleanup.js은 Linux 기반 실행기에서만 실행됩니다.

  post: 'cleanup.js'
  post-if: runner.os == 'linux'

복합 작업을 위한 `runs`

          **필수** 복합 작업의 경로를 구성합니다.

복합 작업을 위한 `runs.using`

          **필수** 이 값을 `'composite'`으로 설정해야 합니다.

`runs.steps`

          **필수** 이 작업에서 실행할 단계입니다. 이는 `run` 단계 또는 `uses` 단계일 수 있습니다.

`runs.steps[*].shell`

          **선택 사항** 명령을 실행할 셸입니다. 
          [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell)에 나열된 모든 셸을 사용할 수 있습니다. 
          `run`이 설정된 경우 필수입니다.

`runs.steps[*].if`

          **선택 사항**`if` 조건을 사용하여 조건이 충족되지 않는 한 단계가 실행되지 않도록 할 수 있습니다. 지원되는 컨텍스트 및 식을 사용하여 조건을 만들 수 있습니다.

if 조건에서 식을 사용하는 경우, 선택에 따라 식 구문(${{ }})을 생략해도 됩니다. GitHub Actions에서 자동으로 if 조건을 식으로 평가하기 때문입니다. 그러나, 이 예외는 어디에나 적용되지는 않습니다.

${{ }} 식 구문을 사용하거나 !이 YAML 형식으로 예약된 표기법이므로 ! 식이 시작될 때 항상 '', "", () 이스케이프를 사용해야 합니다. 예시:

if: ${{ ! startsWith(github.ref, 'refs/tags/') }}

자세한 내용은 워크플로 및 작업에서 식 평가을(를) 참조하세요.

          **예: 컨텍스트 사용**

이 단계는 이벤트 유형이 pull_request이고 이벤트 작업이 unassigned인 경우에만 실행됩니다.

steps:
  - run: echo This event is a pull request that had an assignee removed.
    if: ${{ github.event_name == 'pull_request' && github.event.action == 'unassigned' }}

          **예: 상태 검사 함수 사용**

          `my backup step`은 복합 작업의 이전 단계가 실패한 경우에만 실행됩니다. 자세한 내용은 [AUTOTITLE](/actions/learn-github-actions/expressions#status-check-functions)을(를) 참조하세요.

steps:
  - name: My first step
    uses: octo-org/action-name@main
  - name: My backup step
    if: ${{ failure() }}
    uses: actions/heroku@1.0.0

`runs.steps[*].name`

          **선택 사항** 복합 단계의 이름입니다.

`runs.steps[*].id`

          **선택 사항** 단계의 고유 식별자입니다. 
          `id`를 사용하여 컨텍스트에서 단계를 참조할 수 있습니다. 자세한 내용은 [AUTOTITLE](/actions/learn-github-actions/contexts)을(를) 참조하세요.

`runs.steps[*].env`

          **선택 사항** 해당 단계에 대해서만 환경 변수의 `map`을 설정합니다. 워크플로에 저장된 환경 변수를 수정하려면 복합 단계에서 `echo "{name}={value}" >> $GITHUB_ENV`를 사용합니다.

`runs.steps[*].working-directory`

          **선택 사항** 명령이 실행되는 작업 디렉터리를 지정합니다.

`runs.steps[*].uses`

          **선택 사항** 작업 단계의 일부로 실행할 작업을 선택합니다. 작업은 재사용 가능한 코드 단위입니다. 워크플로와 동일한 리포지토리, 퍼블릭 리포지토리 또는 [게시된 Docker 컨테이너 이미지](https://hub.docker.com/)에 정의된 작업을 사용할 수 있습니다.

Git 참조, SHA 또는 Docker 태그 번호를 지정하여 사용 중인 작업의 버전을 포함하는 것이 좋습니다. 버전을 지정하지 않으면 작업 소유자가 업데이트를 게시할 때 워크플로가 중단되거나 예기치 않은 동작이 발생할 수 있습니다.

릴리스된 작업 버전의 커밋 SHA를 사용하는 것이 안정성 및 보안 측면에서 가장 안전합니다.
특정 주요 작업 버전을 사용하면 호환성을 유지하면서 중요한 수정 및 보안 패치를 받을 수 있습니다. 또한 워크플로가 계속 작동하도록 합니다.
작업의 기본 분기를 사용하는 것이 편리할 수 있지만, 누군가 호환성을 깨뜨리는 변경을 포함한 새 주요 버전을 릴리스하는 경우 워크플로가 중단될 수 있습니다.

일부 작업에는 with 키워드를 사용하여 설정해야 하는 입력이 필요합니다. 작업의 추가 정보 파일을 검토하여 필요한 입력을 확인합니다.

runs:
  using: "composite"
  steps:
    # Reference a specific commit
    - uses: actions/checkout@8f4b7f84864484a7bf31766abe9204da3cbe65b3
    # Reference the major version of a release
    - uses: actions/checkout@v5
    # Reference a specific version
    - uses: actions/checkout@v5.2.0
    # Reference a branch
    - uses: actions/checkout@main
    # References a subdirectory in a public GitHub repository at a specific branch, ref, or SHA
    - uses: actions/aws/ec2@main
    # References a local action
    - uses: ./.github/actions/my-action
    # References a docker public registry action
    - uses: docker://gcr.io/cloud-builders/gradle
    # Reference a docker image published on docker hub
    - uses: docker://alpine:3.8

`runs.steps[*].with`

          **선택 사항** 작업에 의해 정의된 입력 매개 변수의 `map`입니다. 각 입력 매개 변수는 키/값 쌍입니다. 자세한 내용은 [예: 입력 지정](#example-specifying-inputs)을 참조하세요.

runs:
  using: "composite"
  steps:
    - name: My first step
      uses: actions/hello_world@main
      with:
        first_name: Mona
        middle_name: The
        last_name: Octocat

`runs.steps[*].continue-on-error`

          **선택적**  단계가 실패할 때 작업이 실패하지 않도록 합니다. 이 단계가 실패해도 작업이 통과되도록 하려면 `true`로 설정합니다.

환경 변수를 작업에 전달해야 하는 경우 작업이 명령 셸을 실행하여 변수 대체를 수행하는지 확인하세요. 예를 들어 entrypoint 특성이 "sh -c"로 설정된 경우 args는 명령 셸에서 실행됩니다. 또는 Dockerfile이 ENTRYPOINT를 사용하여 동일한 명령("sh -c")을 실행하는 경우 args는 명령 셸에서 실행됩니다.

          `CMD` 명령어를 GitHub Actions와 함께 사용하는 방법에 대한 자세한 내용은 [AUTOTITLE](/actions/creating-actions/dockerfile-support-for-github-actions#cmd)을(를) 참조하세요.

예: Docker 컨테이너에 대한 인수 정의

runs:
  using: 'docker'
  image: 'Dockerfile'
  args:
    - ${{ inputs.greeting }}
    - 'foo'
    - 'bar'

`branding`

          **선택 사항** 색상과 [깃털](https://feathericons.com/) 아이콘을 사용하여 배지를 만들어 작업을 맞춤화하고 구별할 수 있습니다. 배지는 [GitHub Marketplace](https://github.com/marketplace?type=actions)에서 작업 이름 옆에 표시됩니다.

예: 작업에 대한 브랜딩 구성

branding:
  icon: 'award'
  color: 'green'

`branding.color`

배지의 배경색입니다. white, black, yellow, blue, green, orange, red, purple, gray-dark 중 하나일 수 있습니다.

`branding.icon`

사용할 v4.28.0 깃털 아이콘의 이름입니다.

생략된 아이콘

브랜드 아이콘과 다음 아이콘은 모두 생략됩니다.

커피
columns
분할 원
디바이드 스퀘어
나누다
찡그리다
육각형
키
별로야
마우스 포인터
미소
도구
엑스-옥타곤

현재 지원되는 모든 아이콘의 전체 목록

활동
에어플레이
alert-circle
경고-옥타곤
경고 삼각형
가운데 정렬
align-justify
왼쪽 정렬
오른쪽 정렬
앵커
조리개
아카이브
아래쪽 화살표 원
아래쪽-왼쪽 화살표
아래로-오른쪽 화살표
아래쪽 화살표
왼쪽 화살표 원
왼쪽 화살표
앞으로가기-원형
오른쪽 화살표
위쪽 화살표-원
왼쪽 위 화살표
위쪽-오른쪽 화살표
화살표 위로
at-sign
상
바-차트-2
막대 차트
배터리 충전
배터리
벨 소리 끄기
벨 소리
블루투스
굵게
책 열기
책
북마크
박스
서류 가방
달력
카메라 끄기
카메라
형 변환
체크 서클
체크 사각형
확인
아래 화살표
chevron-left
chevron-right
위로 화살표
아래로 향하는 꺽쇠 표시
쉐브론 왼쪽
chevrons-right
상승 화살표
circle
클립보드
시계
구름-이슬비
클라우드-번개
클라우드 끄기
클라우드-레인
구름-눈
클라우드
코드
명령
나침반
복사
왼쪽 아래 모서리
모서리-아래-오른쪽
왼쪽 아래로 코너
왼쪽 위 모서리
오른쪽 아래 모서리
우상단 코너
왼쪽 위 방향
오른쪽 위 모서리로
CPU
신용카드
크롭하다
조준선
데이터베이스
삭제
디스크
달러 기호
download-cloud
다운로드
드롭렛
edit-2
edit-3
편집
외부 링크
눈 끔
눈
빨리 감기
깃털
파일-마이너스
파일 플러스
파일 텍스트
파일
필름
필터
플래그
폴더-마이너스
폴더 추가
폴더
선물
git-branch
git-commit
git-merge (Git 병합 명령어)
git-pull-request (깃 풀 리퀘스트)
지구본
그리드
하드 드라이브
해시
헤드폰
심장
도움말-원형
홈
이미지
받은 편지함
정보
이탤릭
레이어
레이아웃
life-buoy
link-2
link
목록
로더
잠금
로그인
로그아웃
메일
지도 핀
지도
maximize-2
최대화하다
메뉴
메시지 서클
메시지 사각형
마이크 꺼짐
마이크
최소화-2
최소화하다
마이너스 기호가 있는 원
빼기-정사각형
마이너스
모니터
달
더 수평으로
더 수직적
이동
음악
navigation-2
탐색
팔각형
패키지
종이클립
일시 정지-서클
일시 정지
퍼센트
전화 통화
전화 착신 전환
전화-수신
부재중 전화
휴대전화 꺼짐
전화 발신
전화
파이 차트
재생-아이콘
재생
plus-circle
플러스-사각형
더하기
주머니
전력
프린터
라디오
refresh-ccw
refresh-cw
반복하다
되감기
반시계 방향으로 회전
시계 방향 회전
rss
저장
가위
검색
보내기
서버
설정
share-2
공유하다
차폐 해제
보호
쇼핑백
장바구니
셔플
사이드바
되감기
앞으로 건너뛰기
슬래시
슬라이더
스마트폰
스피커
정사각형
별
정지-아이콘
태양
일출
일몰
테이블
태블릿
태그
목표
터미널
온도계
엄지손가락을 내리다
좋아요
왼쪽으로 전환
오른쪽으로 전환
휴지통-2
휴지통
하락 추세
상승 추세
삼각형
트럭
티비
유형
우산
밑줄
잠금을 해제하다
클라우드 업로드
업로드
사용자 확인
유저-마이너스
user-plus
user-x
사용자
사용자
비디오 끄기
video
음성 메시지
권-1
volume-2
volume-x
볼륨
시계
Wi-Fi 꺼짐
wifi
바람
x-circle
x의 제곱
x
빠른 정지
제거
확대
축소

메타데이터 파일 이름 변경

작업 메타데이터 파일은 두 가지 YAML 형식을 모두 지원하지만 릴리스 간에 메타데이터 파일 이름을 action.yml에서 action.yaml로 변경하면 GitHub Marketplace에 게시된 이전 릴리스 버전에 영향을 줍니다. 파일 이름을 변경하면 GitHub Marketplace에서 이전 파일 이름과 관련된 모든 릴리스 버전이 숨겨집니다. 이전 릴리스 버전은 원본 리포지토리를 통해 사용자가 계속 액세스할 수 있습니다.

새 버전의 작업을 릴리스할 때 메타데이터 파일 이름 변경 이후에 릴리스된 버전에만 GitHub Marketplace 태그가 있으며 GitHub Marketplace에 표시됩니다.

이 기사에서