Extensión de Acciones de GitHub Importer con transformadores personalizados

GitHub Actions Importer ofrece la capacidad de ampliar su asignación integrada.

En este artículo

Acerca de los transformadores personalizados

GitHub Actions Importer ofrece la capacidad de ampliar su asignación integrada mediante la creación de transformadores personalizados. Los transformadores personalizados se pueden usar para lo siguiente:

Uso de transformadores personalizados con GitHub Actions Importer

Un transformador personalizado contiene lógica de asignación que GitHub Actions Importer puede usar para transformar los complementos, tareas, etiquetas de ejecutor o variables de entorno para trabajar con GitHub Actions. Los transformadores personalizados se escriben con un lenguaje específico del dominio (DSL) basado en Ruby y se definen dentro de un archivo con la extensión .rb.

Puedes usar la opción de la CLI --custom-transformers para especificar qué archivos de transformador personalizado se usarán con los comandos audit, dry-run y migrate.

Por ejemplo, si los transformadores personalizados se definen en un archivo denominado transformers.rb, puede usar el siguiente comando para usarlos con GitHub Actions Importer:

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

Como alternativa, puedes usar la sintaxis de patrón glob para especificar varios archivos de transformador personalizados. Por ejemplo, si varios archivos de transformador personalizados están dentro de un directorio denominado transformers, puede proporcionarlos todos a GitHub Actions Importer con el siguiente comando:

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

Nota:

Cuando se usan transformadores personalizados, los archivos de transformador personalizado deben residir en el mismo directorio, o en subdirectorios, desde donde se ejecuta el comando gh actions-importer.

Creación de transformadores personalizados para elementos

Puede crear transformadores personalizados que GitHub Actions Importer se usarán al convertir los pasos o desencadenadores de compilación existentes en su equivalente en GitHub Actions. Esto es especialmente útil cuando:

  • GitHub Actions Importer no convierte automáticamente un elemento.
  • Quiere cambiar el modo en que un elemento se convierte mediante GitHub Actions Importer.
  • Las canalizaciones existentes usan extensiones personalizadas o propietarias, como bibliotecas compartidas en Jenkins, y debe definir cómo deben funcionar estos pasos en GitHub Actions.

GitHub Actions Importer usa transformadores personalizados que se definen mediante un DSL basado en Ruby. A fin de crear transformadores personalizados para pasos de compilación y desencadenadores:

  • Cada archivo de transformador personalizado debe contener al menos un método transform.
  • Cada método transform debe devolver un elemento Hash, una matriz de Hash o nil. Este valor devuelto se corresponderá a una acción definida en YAML. Para más información sobre las acciones, consulta Descripción de Acciones de GitHub.

Ejemplo de transformador personalizado para un paso de compilación

En el ejemplo siguiente se convierte un paso de compilación que usa el identificador "buildJavaScriptApp" para ejecutar varios comandos 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

El ejemplo anterior da como resultado el siguiente GitHub Actions paso de flujo de trabajo. Se compone de pasos de compilación convertidos que tenían un identificador buildJavaScriptApp:

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

El método transform usa el identificador de la etapa de construcción de la instancia de CI/CD de origen en un argumento. En este ejemplo, el identificador es buildJavaScriptLibrary. También puedes usar valores separados por comas para pasar varios identificadores al método transform. Por ejemplo: transform "buildJavaScriptApp", "buildTypeScriptApp" { |item| ... }.

Nota:

La estructura de datos de item será diferente en función de la plataforma de CI/CD y del tipo de elemento que se convierta.

Creación de transformadores personalizados para ejecutores

Puede personalizar la asignación entre ejecutores de la instancia de CI/CD de origen y sus ejecutores equivalentes GitHub Actions .

GitHub Actions Importer usa transformadores personalizados que se definen mediante un DSL basado en Ruby. A fin de crear transformadores personalizados para ejecutores:

  • El archivo de transformador personalizado debe contener al menos un método runner.
  • El método runner acepta dos parámetros. El primer parámetro es la etiqueta del ejecutor de la instancia de CI/CD de origen y el segundo parámetro es la etiqueta del ejecutor correspondiente GitHub Actions . Para obtener más información sobre GitHub Actions los ejecutores, consulte Ejecutores hospedados en GitHub.

Transformadores personalizados de ejemplo para ejecutores

En el ejemplo siguiente se muestra un runner método que convierte una etiqueta de ejecutor en una GitHub Actions etiqueta de ejecutor en el flujo de trabajo resultante.

Ruby
runner "linux", "ubuntu-latest"

También puede usar el runner método para convertir una etiqueta de ejecutor en varias GitHub Actions etiquetas de ejecutor en el flujo de trabajo resultante.

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

GitHub Actions Importer intenta asignar la etiqueta del ejecutor lo mejor posible. Cuando no puede hacerlo, se usa como valor predeterminado la etiqueta de ejecutor ubuntu-latest. Puedes usar una palabra clave especial con el método runner para controlar este valor predeterminado. Por ejemplo, el siguiente transformador personalizado indica GitHub Actions Importer que use macos-latest como ejecutor predeterminado en lugar de ubuntu-latest.

Ruby
runner :default, "macos-latest"

Creación de transformadores personalizados para variables de entorno

Puede personalizar la asignación entre variables de entorno en las canalizaciones de CI/CD de origen a sus valores en GitHub Actions.

GitHub Actions Importer usa transformadores personalizados que se definen mediante un DSL basado en Ruby. A fin de crear transformadores personalizados para variables de entorno:

  • El archivo de transformador personalizado debe contener al menos un método env.
  • El método env acepta dos parámetros. El primer parámetro es el nombre de la variable de entorno de la canalización original y el segundo parámetro es el valor actualizado de la variable de entorno para GitHub Actions. Para obtener más información sobre GitHub Actions las variables de entorno, consulte Almacenamiento de información en variables.

Transformadores personalizados de ejemplo para variables de entorno

Hay varias maneras de configurar transformadores personalizados para asignar las variables de entorno.

  • En el ejemplo siguiente se establece el valor de cualquier variable de entorno existente denominada OCTO, en CAT al transformar una canalización.

    Ruby
    env "OCTO", "CAT"

    También puede quitar todas las instancias de una variable de entorno específica para que no se transformen en un GitHub Actions flujo de trabajo. En el ejemplo siguiente se quitan todas las variables de entorno con el nombre MONA_LISA.

    Ruby
    env "MONA_LISA", nil

  • También puedes asignar las variables de entorno existentes a secretos. Por ejemplo, el método env siguiente asigna una variable de entorno denominada MONALISA a un secreto denominado OCTOCAT.

    Ruby
    env "MONALISA", secret("OCTOCAT")

    Esto configurará una referencia a un secreto denominado OCTOCAT en el flujo de trabajo transformado. Para que el secreto funcione, deberá crear el secreto en el repositorio de GitHub. Para más información, consulta Uso de secretos en Acciones de GitHub.

  • También puedes usar expresiones regulares para actualizar los valores de varias variables de entorno a la vez. Por ejemplo, el transformador personalizado siguiente quita todas las variables de entorno del flujo de trabajo convertido:

    Ruby
    env /.*/, nil

    En el ejemplo siguiente se usa un grupo de coincidencias de expresiones regulares para transformar los valores de las variables de entorno en secretos generados de manera dinámica.

    Ruby
    env /^(.+)_SSH_KEY/, secret("%s_SSH_KEY)

    Nota:

    Al usar expresiones regulares, el orden en que se definen los métodos env es importante. El primer transformador env que coincide con un nombre de variable de entorno tiene prioridad sobre los métodos env posteriores. Primero debes definir los transformadores de variables de entorno más específicos.

Algunas partes se han adaptado a partir de https://github.com/github/gh-actions-importer/ con licencia MIT:

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.