• 사용 예
  • Vue 구성
  • 템플릿
  • 결과
  • 커밋 단계
• 컴포넌트 API 참조
  • Props
  • 이벤트
  • 템플릿 파일 위치
• 템플릿 참조
  • 템플릿
  • 단계 참조
  • 입력 참조
  • 위젯
    • 텍스트
    • 디렉터리
    • 체크리스트
      • 체크리스트 항목

파이프라인 위저드

파이프라인 위저드는 Vue 프론트엔드 컴포넌트로, 입력 필드를 사용하여 파이프라인을 만드는 사용자를 돕습니다. 입력 필드의 유형과 최종 파이프라인의 형식은 YAML 템플릿에 의해 구성됩니다.

파이프라인 위저드는 사용자 흐름을 구성하는 단일 템플릿 파일을 기대합니다. 위저드는 파일의 내용에 대해 중립적이므로 위저드를 사용하여 다양한 흐름을 표시할 수 있습니다. 예를 들어 정적 사이트를 위한 템플릿 파일, Docker 이미지를 위한 템플릿 파일, 모바일 앱을 위한 템플릿 파일 등이 있을 수 있습니다. 첫 번째 반복에서 이러한 템플릿은 GitLab 소스 코드의 일부입니다.

템플릿 파일은 여러 단계를 정의합니다. 사용자에게 표시되는 마지막 단계는 항상 커밋이며, 템플릿 정의의 일부가 아닙니다. 이상적인 사용자 경험은 2-3개의 단계가 필요하며, 사용자에게 표시되는 총 3-4개의 단계가 있어야 합니다.

사용 예

Vue 구성

<!-- ~/my_feature/my_component.vue -->

<script>
  import PipelineWizard from '~/pipeline_wizard/pipeline_wizard.vue'
  import template from '~/pipeline_wizard/templates/my_template.yml';
  
  export default {
    name: "MyComponent",
    components: { PipelineWizard },
    data() {
      return { template }
    },
    methods: {
      onDone() {
        // redirect
      }
     }
  }
</script>

<template>
  <pipeline-wizard :template="template"
                   project-path="foo/bar"
                   default-branch="main"
                   @done="onDone" />
</template>

템플릿

# ~/pipeline_wizard/templates/my_template.yml
id: gitlab/my-template
title: 특정 기술 파이프라인 설정
description: 이 위저드가 무엇을 설정하는지에 대한 두세 문장이 포함된 소개
steps:
  # 단계 1
  - inputs:
      # 첫 번째 입력 위젯
      - label: 빌드 이미지 선택
        description: 이미지를 빌드하는 데 사용할 Docker 이미지
        placeholder: node:lts
        widget: text
        target: $BUILD_IMAGE
        required: true
        pattern: "^(?:(?=[^:\/]{1,253})(?!-)[a-zA-Z0-9-]{1,63}(?<!-)(?:\.(?!-)[a-zA-Z0-9-]{1,63}(?<!-))*(?::[0-9]{1,5})?\/)?((?![._-])(?:[a-z0-9._-]*)(?<![._-])(?:\/(?![._-])[a-z0-9._-]*(?<![._-]))*)(?::(?![.-])[a-zA-Z0-9_.-]{1,128})?$"
        invalid-feedback: 유효한 도커 이미지를 입력하세요
      
      # 두 번째 입력 위젯
      - label: 설치 단계
        description: "로컬 빌드 환경을 설정하기 위해 실행해야 하는 단계(예: 의존성 설치)"
        placeholder: npm ci
        widget: list
        target: $INSTALLATION_STEPS
    
    # 사용자에 의해 입력된 값으로 최종 파이프라인 파일에 복사하고 업데이트할 템플릿
    template:
      my-job:
        # 앱을 빌드하는 데 사용될 Docker 이미지
        image: $BUILD_IMAGE
        
        before_script: $INSTALLATION_STEPS
        
        artifacts:
          paths:
            - foo
  
  # 단계 2
  - inputs:
      # 이 단계의 유일한 입력 위젯
      - label: 설치 단계
        description: "로컬 빌드 환경을 설정하기 위해 실행해야 하는 단계(예: 의존성 설치)"
        placeholder: npm ci
        widget: list
        target: $INSTALLATION_STEPS
    
    template:
      # 빌드 스크립트가 실행되기 전에 실행해야 하는 기능
      before_script: $INSTALLATION_STEPS

결과

커밋 단계

위저드의 마지막 단계는 항상 커밋 단계입니다. 사용자는 위저드의 props로 정의된 리포지터리에 새로 생성된 파일을 커밋할 수 있습니다. 사용자는 커밋할 브랜치를 변경할 수 있습니다. 향후 반복에서는 여기에서 MR을 생성할 수 있는 기능이 추가될 예정입니다.

컴포넌트 API 참조

Props

• template (필수): 미구문 분석된 문자열로 템플릿 내용. 자세한 내용은 템플릿 파일 위치를 참조하세요.
• project-path (필수): 파일이 커밋될 프로젝트의 전체 경로
• default-branch (필수): 커밋 단계 중 미리 선택되어 있는 브랜치. 사용자가 변경할 수 있습니다.
• default-filename (옵션, 기본값: .gitlab-ci.yml): 파일에 사용될 파일 이름. 템플릿 파일에서 재정의할 수 있습니다.

이벤트

• done - 파일이 커밋된 후에 발생합니다. 이를 사용하여 사용자를 예를 들어 파이프라인으로 리디렉션하세요.

템플릿 파일 위치

템플릿 파일은 일반적으로 ~/pipeline_wizard/templates/에 YAML 파일로 저장됩니다.

PipelineWizard 컴포넌트는 template 속성을 미구문 분석된 String으로 기대하며, Webpack은 위의 폴더에서 .yml 파일을 문자열로 로드하도록 구성되어 있습니다. 다른 위치에서 파일을 로드해야 하는 경우 Webpack이 개체로 구문 분석하지 않도록 주의하세요.

템플릿 참조

템플릿

템플릿 파일의 루트 요소에서 다음 속성을 정의할 수 있습니다:

단계 참조

하나의 단계는 다단계(또는 페이지) 프로세스의 한 페이지를 구성합니다. 이는 최종 .gitlab-ci.yml의 일부를 형성하는 하나 이상의 관련 입력 필드로 구성됩니다.

단계에는 두 가지 속성이 포함되어 있습니다:

입력 참조

각 단계에는 하나 이상의 inputs가 포함될 수 있습니다. 이상적인 사용자 경험을 위해 세 개 이상을 포함하면 안 되며, 입력의 모양과 느낌, 그리고 이것이 생성하는 YAML 유형(문자열, 디렉터리 등)은 사용되는 위젯에 따라 다릅니다. widget: text는 텍스트 입력을 나타내며 사용자의 입력을 문자열로 템플릿에 삽입합니다. widget: list는 하나 이상의 입력 필드를 표시하고 디렉터리을 삽입합니다.

모든 inputs는 label, widget, 그리고 선택적으로 target를 가져야 하지만 대부분의 속성은 사용되는 위젯에 따라 종속됩니다:

위젯

텍스트

widget: text를 사용합니다. 이는 YAML 파일에 string을 삽입합니다.

디렉터리

widget: list를 사용합니다. 이는 YAML 파일에 list를 삽입합니다.

체크리스트

widget: checklist를 사용합니다. 이는 다음 단계로 진행하기 전에 선택해야 하는 확인란 디렉터리을 삽입합니다.

체크리스트 항목