조직을 위한 워크플로우 템플릿 만들기

조직을 위한 워크플로우 템플릿 만들기

팀의 사람들이 새 워크플로우를 더 쉽게 추가할 수 있도록 워크플로우 템플릿을 만드는 방법을 알려드릴게요.

출처: 문서

본문

팀의 사람들이 새 워크플로우를 더 쉽게 추가할 수 있도록 워크플로우 템플릿을 만들 수 있어요.

워크플로우 템플릿 만들기

이 절차는 워크플로우 템플릿과 메타데이터 파일을 만드는 방법을 보여줍니다. 메타데이터 파일은 사용자가 새 워크플로우를 만들 때 워크플로우 템플릿이 어떻게 표시될지 설명해요.

  1. 아직 없다면 조직에 .github라는 새 저장소를 만드세요.

  2. workflow-templates라는 디렉토리를 만드세요.

  3. workflow-templates 디렉토리 안에 새 워크플로우 파일을 만드세요.

    저장소의 기본 브랜치를 참조해야 한다면 $default-branch 플레이스홀더를 사용할 수 있어요. 워크플로우가 생성되면 플레이스홀더가 자동으로 저장소의 기본 브랜치 이름으로 바뀝니다.

    예를 들어 octo-organization-ci.yml이라는 이 파일은 기본 워크플로우를 보여줍니다.

    name: Octo Organization CI

on:
  push:
    branches: [ $default-branch ]
  pull_request:
    branches: [ $default-branch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6

      - name: Run a one-line script
        run: echo Hello from Octo Organization

  4. workflow-templates 디렉토리 안에 메타데이터 파일을 만드세요. 메타데이터 파일은 워크플로우 파일과 이름이 같아야 하지만, .yml 확장자 대신 .properties.json이 붙어야 합니다. 예를 들어 octo-organization-ci.properties.json이라는 이 파일은 octo-organization-ci.yml이라는 워크플로우 파일에 대한 메타데이터를 포함해요:

    {
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI workflow template.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}
    • name - 필수. 워크플로우의 이름. 사용 가능한 워크플로우 목록에 표시됩니다.
    • description - 필수. 워크플로우의 설명. 사용 가능한 워크플로우 목록에 표시됩니다.
    • iconName - 선택. 워크플로우 목록에 표시되는 워크플로우 아이콘을 지정합니다. iconName은 다음 유형 중 하나일 수 있어요:
      • workflow-templates 디렉토리에 저장된 SVG 파일. 파일을 참조하려면 값이 확장자 없는 파일 이름이어야 합니다. 예를 들어 example-icon.svg라는 SVG 파일은 example-icon으로 참조됩니다.
      • GitHub의 Octicons 세트의 아이콘. 옥티콘을 참조하려면 값이 octicon <icon name>이어야 합니다. 예: octicon smiley.
    • categories - 선택. 워크플로우가 표시되는 카테고리를 정의합니다. 다음 목록의 카테고리 이름을 사용할 수 있어요:
    • filePatterns - 선택. 사용자의 저장소 루트 디렉토리에 정의된 정규 표현식과 일치하는 파일이 있으면 워크플로우를 사용할 수 있게 해줍니다.

  5. 다른 워크플로우 템플릿을 추가하려면 같은 workflow-templates 디렉토리에 파일을 추가하세요.

다음 단계

더 알아보기 (Learn more)