사용자 지정 변환기를 사용하여 GitHub Actions Importer 확장

사용자 지정 변환기 정보

GitHub Actions Importer는 사용자 지정 변환기를 만들어 기본 제공 매핑을 확장하는 기능을 제공합니다. 사용자 지정 변환기를 사용하여 다음을 수행할 수 있습니다.

GitHub Actions Importer이(가) 자동으로 변환하지 않는 항목을 변환하거나 항목 변환 방법을 수정합니다. 자세한 내용은 "항목에 대한 사용자 지정 변환기 만들기"를 참조하세요.
다른 실행기 레이블을 사용하도록 참조를 실행기로 변환합니다. 자세한 내용은 "실행기를 위한 사용자 지정 변환기 만들기"를 참조하세요.
환경 변수 값을 기존 파이프라인에서 GitHub Actions 워크플로로 변환합니다. 자세한 내용은 "환경 변수에 대한 사용자 지정 변환기 만들기"를 참조하세요.

GitHub Actions Importer와 함께 사용자 지정 변환기 사용

사용자 지정 변환기에는 GitHub Actions Importer이(가) GitHub Actions에서 작동하도록 플러그 인, 작업, 실행기 레이블 또는 환경 변수를 변환하는 데 사용할 수 있는 매핑 논리가 포함되어 있습니다. 사용자 지정 변환기는 Ruby를 기반으로 빌드된 DSL(도메인별 언어)으로 작성되며 파일 확장명의 .rb 파일 내에서 정의됩니다.

CLI 옵션을 사용하여 --custom-transformers , dry-run및 명령과 migrate 함께 audit사용할 사용자 지정 변환기 파일을 지정할 수 있습니다.

예를 들어 사용자 지정 변환기가 라는 transformers.rb파일에 정의된 경우 다음 명령을 사용하여 GitHub Actions Importer와 함께 사용할 수 있습니다.

gh actions-importer ... --custom-transformers transformers.rb

또는 glob 패턴 구문을 사용하여 여러 사용자 지정 변환기 파일을 지정할 수 있습니다. 예를 들어 여러 사용자 지정 변환기 파일이 라는 transformers디렉터리 내에 있는 경우 다음 명령을 사용하여 GitHub Actions Importer에 모두 제공할 수 있습니다.

gh actions-importer ... --custom-transformers transformers/*.rb

참고: 사용자 지정 변환기를 사용하는 경우 사용자 지정 변환기 파일은 명령이 실행되는 동일한 디렉터리 또는 하위 디렉터리에 gh actions-importer 있어야 합니다.

항목에 대한 사용자 지정 변환기 만들기

기존 빌드 단계 또는 트리거를 GitHub Actions에서 해당 항목으로 변환할 때 GitHub Actions Importer에서 사용할 사용자 지정 변환기를 만들 수 있습니다. 이는 다음과 같은 경우에 특히 유용합니다.

GitHub Actions Importer은(는) 항목을 자동으로 변환하지 않습니다.
GitHub Actions Importer에서 항목을 변환하는 방법을 변경하려고 합니다.
기존 파이프라인은 Jenkins의 공유 라이브러리와 같은 사용자 지정 또는 독점 확장을 사용하며 GitHub Actions에서 이러한 단계가 작동하는 방식을 정의해야 합니다.

GitHub Actions Importer은 Ruby 위에 빌드된 DSL을 사용하여 정의된 사용자 지정 변환기를 사용합니다. 빌드 단계 및 트리거에 대한 사용자 지정 변환기를 만들려면 다음을 수행합니다.

각 사용자 지정 변환기 파일에는 하나 이상의 transform 메서드가 포함되어야 합니다.
각 transform 메서드는 Hash, 의 Hash배열 또는 nil를 반환해야 합니다. 반환된 이 값은 YAML에 정의된 작업에 해당합니다. 작업에 대한 자세한 내용은 "GitHub Actions 이해"을 참조하세요.

빌드 단계에 대한 사용자 지정 변환기 예제

다음 예제에서는 "buildJavascriptApp" 식별자를 사용하여 다양한 npm 명령을 실행하는 빌드 단계를 변환합니다.

Ruby

transform "buildJavascriptApp" do |item|
  command = ["build", "package", "deploy"].map do |script|
    "npm run #{script}"
  end

  {
    name: "build javascript app",
    run: command.join("\n")
  }
end

위의 예제에서는 다음 GitHub Actions 워크플로 단계를 수행합니다. 식별자가 있는 변환된 빌드 단계로 buildJavascriptApp 구성됩니다.

- name: build javascript app
  run: |
    npm run build
    npm run package
    npm run deploy

메서드는 transform 인수에서 원본 CI/CD 인스턴스의 빌드 단계 식별자를 사용합니다. 이 예제에서 식별자는 입니다 buildJavascriptLibrary. 쉼표로 구분된 값을 사용하여 여러 식별자를 메서드에 transform 전달할 수도 있습니다. 예: transform "buildJavascriptApp", "buildTypescriptApp" { |item| ... }.

참고: 의 item 데이터 구조는 CI/CD 플랫폼 및 변환되는 항목 유형에 따라 달라집니다.

실행기를 위한 사용자 지정 변환기 만들기

원본 CI/CD 인스턴스의 실행기와 해당 GitHub Actions 실행기 간의 매핑을 사용자 지정할 수 있습니다.

GitHub Actions Importer은 Ruby 위에 빌드된 DSL을 사용하여 정의된 사용자 지정 변환기를 사용합니다. 실행기에 대한 사용자 지정 변환기를 만들려면 다음을 수행합니다.

사용자 지정 변환기 파일에는 메서드가 하나 runner 이상 있어야 합니다.
메서드는 runner 두 개의 매개 변수를 허용합니다. 첫 번째 매개 변수는 원본 CI/CD 인스턴스의 실행기 레이블이고 두 번째 매개 변수는 해당 GitHub Actions 실행기 레이블입니다. GitHub Actions 실행기에 대한 자세한 내용은 "GitHub 호스팅 실행기 정보"을 참조하세요.

실행기에 대한 사용자 지정 변환기 예제

다음 예제에서는 결과 워크플로에서 하나의 실행기 레이블을 하나의 GitHub Actions 실행기 레이블로 변환하는 메서드를 보여 runner 줍니다.

Ruby

runner "linux", "ubuntu-latest"

메서드를 사용하여 결과 워크플로에서 runner 하나의 실행기 레이블을 여러 GitHub Actions 실행기 레이블로 변환할 수도 있습니다.

Ruby

runner "big-agent", ["self-hosted", "xl", "linux"]

GitHub Actions Importer는 실행기 레이블을 최대한 매핑하려고 시도합니다. 이 작업을 수행할 수 없는 경우 실행기 ubuntu-latest 레이블이 기본값으로 사용됩니다. 메서드와 함께 특수 키워드를 runner 사용하여 이 기본값을 제어할 수 있습니다. 예를 들어 다음 사용자 지정 변환기는 GitHub Actions Importer가 대신 ubuntu-latest기본 실행기로 사용하도록 macos-latest 지시합니다.

Ruby

runner :default, "macos-latest"

환경 변수에 대한 사용자 지정 변환기 만들기

원본 CI/CD 파이프라인의 환경 변수 간 매핑을 GitHub Actions의 값으로 사용자 지정할 수 있습니다.

GitHub Actions Importer은 Ruby 위에 빌드된 DSL을 사용하여 정의된 사용자 지정 변환기를 사용합니다. 환경 변수에 대한 사용자 지정 변환기를 만들려면 다음을 수행합니다.

사용자 지정 변환기 파일에는 메서드가 하나 env 이상 있어야 합니다.
메서드는 env 두 개의 매개 변수를 허용합니다. 첫 번째 매개 변수는 원래 파이프라인의 환경 변수 이름이고 두 번째 매개 변수는 GitHub Actions의 환경 변수에 대한 업데이트된 값입니다. GitHub Actions 환경 변수에 대한 자세한 내용은 "변수.

환경 변수에 대한 사용자 지정 변환기 예제

사용자 지정 변환기를 설정하여 환경 변수를 매핑할 수 있는 여러 가지 방법이 있습니다.

다음 예제에서는 파이프라인을 변환할 때 라는 OCTO기존 환경 변수의 값을 로 CAT 설정합니다.
Ruby
```
env "OCTO", "CAT"
```
특정 환경 변수의 모든 인스턴스를 제거하여 GitHub Actions 워크플로로 변환되지 않도록 할 수도 있습니다. 다음 예제에서는 이름이 MONA_LISA인 모든 환경 변수를 제거합니다.
Ruby
```
env "MONA_LISA", nil
```
기존 환경 변수를 비밀에 매핑할 수도 있습니다. 예를 들어 다음 env 메서드는 라는 환경 변수를 라는 MONALISA OCTOCAT비밀에 매핑합니다.
Ruby
```
env "MONALISA", secret("OCTOCAT")
```
이렇게 하면 변환된 워크플로에서 라는 OCTOCAT 비밀에 대한 참조가 설정됩니다. 비밀이 작동하려면 GitHub 리포지토리에서 비밀을 만들어야 합니다. 자세한 내용은 "암호화된 비밀"을 참조하세요.
정규식을 사용하여 여러 환경 변수의 값을 한 번에 업데이트할 수도 있습니다. 예를 들어 다음 사용자 지정 변환기는 변환된 워크플로에서 모든 환경 변수를 제거합니다.
Ruby
```
env /.*/, nil
```
다음 예제에서는 정규식 일치 그룹을 사용하여 환경 변수 값을 동적으로 생성된 비밀로 변환합니다.
Ruby
```
env /^(.+)_SSH_KEY/, secret("%s_SSH_KEY)
```
참고: 메서드가 env 정의된 순서는 정규식을 사용할 때 중요합니다. 환경 변수 이름과 일치하는 첫 번째 env 변환기가 후속 env 메서드보다 우선합니다. 가장 구체적인 환경 변수 변환기를 먼저 정의해야 합니다.

법적 고지 사항

일부는 MIT 라이선스에 따라 조정 https://github.com/github/gh-actions-importer/ 되었습니다.

MIT License

Copyright (c) 2022 GitHub

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

사용자 지정 변환기를 사용하여 GitHub Actions Importer 확장

이 문서의 내용