Migración desde Jenkins con el importador de Acciones de GitHub

Aprende a usar el GitHub Actions Importer para automatizar la migración de tus canalizaciones de Jenkins a GitHub Actions.

En este artículo

Aviso legal

Acerca de la migración desde Jenkins con el importador de Acciones de GitHub

Las instrucciones siguientes te guiarán por el proceso de configuración de tu entorno para usar GitHub Actions Importer para migrar las canalizaciones de Jenkins a GitHub Actions.

Requisitos previos

  • Una cuenta u organización de Jenkins con canalizaciones y trabajos que quieras convertir en flujos de trabajo de GitHub Actions.

  • Acceso para crear un token de API personal de Jenkins para tu cuenta u organización.

  • Un entorno en el que puedas ejecutar contenedores basados en Linux e instalar las herramientas necesarias.

    Nota: El contenedor y la CLI del GitHub Actions Importer no deben estar instalados en el mismo servidor que tu plataforma de CI.

Limitaciones

Hay algunas limitaciones al migrar desde Jenkins a GitHub Actions con GitHub Actions Importer. Por ejemplo, debes migrar manualmente las siguientes construcciones:

  • Herramientas de compilación obligatorias
  • Canalizaciones con script
  • Secretos
  • Ejecutores autohospedados
  • Complementos desconocidos

Para obtener más información sobre las migraciones manuales, consulta "Migrar de Jenkins a GitHub Actions".

Instalación de la extensión de la CLI del GitHub Actions Importer

  1. Instala la extensión de la CLI del GitHub Actions Importer:

    Bash
    gh extension install github/gh-actions-importer

  2. Comprueba que la extensión está instalada:

    $ gh actions-importer -h
Options:
  -?, -h, --help  Show help and usage information

Commands:
  update     Update to the latest version of GitHub Actions Importer.
  version    Display the version of GitHub Actions Importer.
  configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
  audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
  forecast   Forecast GitHub Actions usage from historical pipeline utilization.
  dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
  migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.

Configuración de credenciales

El comando configure de la CLI se usa para establecer las credenciales y opciones necesarias para GitHub Actions Importer al trabajar con Jenkins y GitHub.

  1. Crea un GitHub personal access token (classic). Para obtener más información, vea «Administración de tokens de acceso personal».

    El token debe tener el ámbito workflow.

    Después de crear el token, cópialo y guárdalo en una ubicación segura para utilizarlo más adelante.

  2. Crea un token de API de Jenkins. Para obtener más información, consulta Autenticación de clientes con scripts en la documentación de Jenkins.

    Después de crear el token, cópialo y guárdalo en una ubicación segura para utilizarlo más adelante.

  3. En el terminal, ejecuta el comando configure de la CLI de GitHub Actions Importer:

    gh actions-importer configure

    El comando configure te pedirá la siguiente información:

    • En "¿Qué proveedores de CI estás configurando?", usa las teclas de dirección para seleccionar Jenkins, presiona Espacio para seleccionarlo y, a continuación, presiona Entrar.
    • En "Personal access token para GitHub", escribe el valor del personal access token (classic) que has creado anteriormente y presiona Entrar.
    • En "Dirección URL base de la instancia de GitHub", presiona Entrar para aceptar el valor predeterminado (https://github.com).
    • En "Personal access token para Jenkins", escribe el valor del token de API personal de Jenkins que has creado anteriormente y presiona Entrar.
    • En "Nombre del usuario de Jenkins", escribe el nombre de usuario de Jenkins y presiona Entrar.
    • En "Dirección URL base de la instancia de Jenkins", escribe la dirección URL de la instancia de Jenkins y presiona Entrar.

    A continuación se muestra un ejemplo del comando configure:

    $ gh actions-importer configure
✔ Which CI providers are you configuring?: Jenkins
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Jenkins: ***************
✔ Username of Jenkins user: admin
✔ Base url of the Jenkins instance: https://localhost
Environment variables successfully updated.

  4. En el terminal, ejecuta el comando update de la CLI de GitHub Actions Importer para conectarte a GitHub Packages Container registry y asegúrate de que la imagen de contenedor esté actualizada a la versión más reciente:

    gh actions-importer update

    El resultado del comando debe ser similar al siguiente:

    Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date

Realización de una auditoría de Jenkins

Puedes usar el comando audit para obtener una vista de alto nivel de todas las canalizaciones de un servidor de Jenkins.

El comando audit realiza los pasos siguientes:

  1. Captura todos los proyectos definidos en un servidor de Jenkins.
  2. Convierte cada canalización en su flujo de trabajo equivalente de GitHub Actions.
  3. Genera un informe que resume cuán compleja y completa puede ser una migración con GitHub Actions Importer.

Ejecución del comando de auditoría

Para realizar una auditoría de un servidor de Jenkins, ejecuta el siguiente comando en el terminal:

gh actions-importer audit jenkins --output-dir tmp/audit

Inspección de los resultados de la auditoría

Los archivos del directorio de salida especificado contienen los resultados de la auditoría. Consulta el archivo audit_summary.md para obtener un resumen de los resultados de la auditoría.

El resumen de la auditoría tiene las secciones siguientes.

Pipelines

La sección "Canalizaciones" contiene estadísticas de alto nivel con respecto a la tasa de conversión realizada por GitHub Actions Importer.

A continuación se incluyen algunos términos clave que pueden aparecer en la sección "Canalizaciones":

  • En las canalizaciones correctas, el 100 % de las construcciones de canalización y los elementos individuales se convirtieron automáticamente en sus GitHub Actions equivalentes.
  • En las canalizaciones parcialmente correctas, se convirtieron todas sus construcciones de canalización, pero algunos elementos individuales no se convirtieron automáticamente en sus GitHub Actions equivalentes.
  • Las canalizaciones no admitidas son tipos de definición que no son compatibles con GitHub Actions Importer.
  • En las canalizaciones con error, se produjo un error grave al realizar la conversión. Esto puede deberse a uno de los siguientes motivos:
    • La canalización se configuró mal originalmente y no es válida.
    • GitHub Actions Importer encontró un error interno al convertirla.
    • Se produjo una respuesta de red incorrecta que hizo que la canalización fuera inaccesible, lo que a menudo se debe a credenciales no válidas.

Pasos de compilación

La sección "Pasos de compilación" contiene información general sobre los pasos de compilación individuales que se usan en todas las canalizaciones y cuántos se han convertido automáticamente mediante GitHub Actions Importer.

A continuación se incluyen algunos términos clave que pueden aparecer en la sección "Pasos de compilación":

  • Un paso de compilación conocido es un paso que se ha convertido automáticamente en una acción equivalente.
  • Un paso de compilación desconocido es un paso que no se ha convertido automáticamente en una acción equivalente.
  • Un paso de compilación no admitido es un paso que:
    • Esencialmente, no es compatible con GitHub Actions.
    • Se ha configurado de una manera que es incompatible con GitHub Actions.
  • Una acción es una lista de las acciones que se han usado en los flujos de trabajo convertidos. Esto puede ser importante por las siguientes razones:
    • Si usas GitHub Enterprise Server, recopilar la lista de acciones que se deben sincronizar con la instancia.
    • Definir una lista de permitidos de nivel de organización de las acciones que se usan. Esta lista de acciones es una lista completa de las acciones que puede que los equipos de seguridad o cumplimiento deban revisar.

Tareas manuales

La sección "Tareas manuales" contiene información general sobre las tareas que GitHub Actions Importer no puede completar automáticamente y que debes completar manualmente.

A continuación se incluyen algunos términos clave que pueden aparecer en la sección "Tareas manuales":

  • Un secreto es un secreto de nivel de repositorio u organización que se usa en las canalizaciones convertidas. Estos secretos deben crearse manualmente en GitHub Actions para que estas canalizaciones funcionen correctamente. Para obtener más información, vea «Uso de secretos en Acciones de GitHub».
  • Un ejecutor autohospedado hace referencia a una etiqueta de un ejecutor al que se hace referencia en una canalización convertida que no es un ejecutor hospedado por GitHub. Tendrás que definir manualmente estos ejecutores para que estas canalizaciones funcionen correctamente.

Archivos

La sección final del informe de auditoría proporciona un manifiesto de todos los archivos que se escribieron en el disco durante la auditoría.

Cada archivo de canalización tiene varios archivos incluidos en la auditoría, entre los que se incluyen:

  • La canalización original tal como se definió en GitHub.
  • Las respuestas de red usadas para convertir la canalización.
  • El archivo del flujo de trabajo convertido.
  • Los seguimientos de pila que se pueden usar para solucionar problemas de una conversión de canalización con errores.

Además, el archivo workflow_usage.csv contiene una lista separada por comas de todas las acciones, los secretos y los ejecutores que usa cada una de las canalizaciones convertidas correctamente. Esto puede ser útil para determinar qué flujos de trabajo usan qué acciones, secretos o ejecutores, así como para realizar revisiones de seguridad.

Previsión del posible uso del ejecutor de compilación

Puedes usar el comando forecast para predecir el uso potencial de GitHub Actions mediante el cálculo de métricas a partir de las ejecuciones de canalización completadas en el servidor de Jenkins.

Requisitos previos para ejecutar el comando de previsión

Para ejecutar el comando forecast en una instancia de Jenkins, debes instalar el complemento paginated-builds en el servidor de Jenkins. Este complemento permite que GitHub Actions Importer recupere eficazmente los datos de compilación históricos de los trabajos que tienen un gran número de compilaciones. Dado que Jenkins no proporciona un método para recuperar datos de compilación paginados, el uso de este complemento impide que se produzcan tiempos de espera del servidor de Jenkins que se pueden producir al recuperar una gran cantidad de datos históricos. El complemento paginated-builds es de código abierto y expone un punto de conexión de la API de REST para recuperar datos de compilación en páginas, en lugar de recupearlos todos a la vez.

Instalación del complemento paginated-builds:

  1. En la instancia de Jenkins, ve a https://<your-jenkins-instance>/pluginManager/available.
  2. Busca el complemento paginated-builds.
  3. Activa la casilla de la izquierda y selecciona Instalar sin reinicio.

Ejecución del comando de previsión

Para realizar una previsión de las posibles GitHub Actions, ejecuta el comando siguiente en el terminal. De manera predeterminada, GitHub Actions Importer incluye los siete días anteriores en el informe de previsión.

gh actions-importer forecast jenkins --output-dir tmp/forecast

Inspección del informe de previsión

El archivo forecast_report.md del directorio de salida especificado contiene los resultados de la previsión.

A continuación se incluyen algunos términos clave que pueden aparecer en el informe de previsión:

  • El recuento de trabajos es el número total de trabajos completados.
  • El recuento de canalizaciones es el número de canalizaciones únicas usadas.
  • El tiempo de ejecución describe la cantidad de tiempo que un ejecutor ha dedicado a un trabajo. Esta métrica se puede usar para ayudar a planear el costo de los ejecutores hospedados en GitHub.
    • Esta métrica está correlacionada con la previsión de gasto en GitHub Actions. Esto variará en función del hardware usado durante estos minutos. Puedes usar la calculadora de precios de GitHub Actions para calcular los costos.
  • Las métricas de tiempo de cola describen la cantidad de tiempo que un trabajo ha esperado a que un ejecutor esté disponible para ejecutarlo.
  • Las métricas de trabajos simultáneos describen la cantidad de trabajos que se ejecutan en un momento dado. Esta métrica se puede usar para definir el número de ejecutores que debes configurar.

Además, estas métricas se definen para cada cola de ejecutores de Jenkins. Esto es especialmente útil si hay una combinación de ejecutores hospedados o autohospedados, o máquinas de especificación alta o baja, por lo que puedes ver métricas específicas de los diferentes tipos de ejecutores.

Realización de un simulacro de migración de una canalización de Jenkins

Puedes usar el comando dry-run para convertir una canalización de Jenkins en su flujo de trabajo de GitHub Actions equivalente.

Ejecución del comando de simulacro

Puedes usar el comando dry-run para convertir una canalización de Jenkins en un flujo de trabajo de GitHub Actions equivalente. Un simulacro crea los archivos de salida en un directorio especificado, pero no abre una solicitud de incorporación de cambios para migrar la canalización.

Para realizar un simulacro de la migración de las canalizaciones de Jenkins a GitHub Actions, ejecuta el comando siguiente en el terminal, reemplazando my-jenkins-project por la dirección URL del trabajo de Jenkins.

gh actions-importer dry-run jenkins --source-url my-jenkins-project --output-dir tmp/dry-run

Inspección de los flujos de trabajo convertidos

Puedes ver los registros del simulacro y los archivos de flujo de trabajo convertidos en el directorio de salida especificado.

Si hay elementos que GitHub Actions Importer no pudo convertir automáticamente, como pasos de compilación desconocidos o una canalización parcialmente correcta, es posible que quieras crear transformadores personalizados para personalizar aún más el proceso de conversión. Para obtener más información, vea «Extensión Importador de Acciones de GitHub con transformadores personalizados».

Realización de una migración de producción de una canalización de Jenkins

Puedes usar el comando migrate para convertir una canalización de Jenkins y abrir una solicitud de incorporación de cambios con el flujo de trabajo de GitHub Actions equivalente.

Ejecución del comando migrate

Para migrar una canalización de Jenkins a GitHub Actions, ejecuta el comando siguiente en el terminal, reemplazando el valor target-url por la dirección URL del repositorio de GitHub y my-jenkins-project por la dirección URL del trabajo de Jenkins.

gh actions-importer migrate jenkins --target-url https://github.com/:owner/:repo --output-dir tmp/migrate --source-url my-jenkins-project

La salida del comando incluye la dirección URL de la solicitud de incorporación de cambios que agrega el flujo de trabajo convertido al repositorio. Un ejemplo de una salida correcta es similar al siguiente:

$ gh actions-importer migrate jenkins --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --source-url http://localhost:8080/job/monas_dev_work/job/monas_freestyle
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

Inspección de la solicitud de incorporación de cambios

La salida de una ejecución correcta del comando migrate contiene un vínculo a la nueva solicitud de incorporación de cambios que agrega el flujo de trabajo convertido al repositorio.

Entre algunos elementos importantes de la solicitud de incorporación de cambios se incluyen los siguientes:

  • En la descripción de la solicitud de incorporación de cambios, una sección denominada Pasos manuales, que enumera los pasos que debes completar manualmente para poder finalizar la migración de las canalizaciones a GitHub Actions. Por ejemplo, esta sección puede indicarte que crees los secretos usados en los flujos de trabajo.
  • El archivo de flujos de trabajo convertidos. Selecciona la pestaña Archivos cambiados de la solicitud de incorporación de cambios para ver el archivo de flujo de trabajo que se agregará al repositorio de GitHub.

Cuando hayas terminado de inspeccionar la solicitud de incorporación de cambios, puedes combinarla para agregar el flujo de trabajo al repositorio de GitHub.

Referencia

Esta sección contiene información de referencia sobre variables de entorno, argumentos opcionales y sintaxis admitida al usar GitHub Actions Importer para realizar una migración desde Jenkins.

Uso de variables de entorno

GitHub Actions Importer usa variables de entorno para su configuración de autenticación. Estas variables se establecen al seguir el proceso de configuración mediante el comando configure. Para más información, consulta la sección Configuración de credenciales.

GitHub Actions Importer usa las siguientes variables de entorno para conectarse a la instancia de Jenkins:

  • GITHUB_ACCESS_TOKEN: personal access token (classic) usado para crear solicitudes de incorporación de cambios con un flujo de trabajo convertido (requiere los ámbitos repo y workflow).

  • GITHUB_INSTANCE_URL: dirección URL de la instancia de GitHub de destino (por ejemplo, https://github.com).

  • JENKINS_ACCESS_TOKEN: token de API de Jenkins que se usa para ver los recursos de Jenkins.

    Note

    Este token requiere acceso a todos los trabajos que quieres migrar o auditar. En los casos en los que una carpeta o un trabajo no hereden listas de control de acceso de su elemento primario, debes conceder permisos explícitos o privilegios de administrador completos.

  • JENKINS_USERNAME: nombre de usuario de la cuenta de usuario que creó el token de API de Jenkins.

  • JENKINS_INSTANCE_URL: dirección URL de la instancia de Jenkins.

  • JENKINSFILE_ACCESS_TOKEN: (opcional) token de API que se usa para recuperar el contenido de un elemento Jenkinsfile almacenado en el repositorio de compilación. Requiere el ámbito repo. Si no se proporciona, se usará GITHUB_ACCESS_TOKEN en su lugar.

Estas variables de entorno se pueden especificar en un archivo .env.local que GitHub Actions Importer carga cuando se ejecuta.

Uso de argumentos opcionales

Hay argumentos opcionales que puedes usar con los subcomandos de GitHub Actions Importer para personalizar la migración.

--source-file-path

Puedes usar el argumento --source-file-path con los subcomandos forecast, dry-run o migration.

De manera predeterminada, GitHub Actions Importer captura el contenido de la canalización del control de código fuente. El argumento --source-file-path indica a GitHub Actions Importer que use la ruta de acceso del archivo de origen especificado en su lugar. Puedes usar esta opción para las canalizaciones Jenkinsfile y multibranch.

Si quieres proporcionar varios archivos de origen al ejecutar el subcomando forecast, puedes usar la coincidencia de patrones en el valor de ruta de acceso del archivo. Por ejemplo, gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json proporciona a GitHub Actions Importer los archivos de origen que coincidan con la ruta de acceso del archivo ./tmp/previous_forecast/jobs/*.json.

Ejemplo de canalización Jenkinsfile

En este ejemplo, GitHub Actions Importer usa el Jenkinsfile especificado como archivo de origen para realizar un simulacro.

gh actions-importer dry-run jenkins --output-dir path/to/output/ --source-file-path path/to/Jenkinsfile --source-url :url_to_jenkins_job

--config-file-path

Puedes usar el argumento --config-file-path con los subcomandos audit, dry-run y migrate.

De manera predeterminada, GitHub Actions Importer captura el contenido de la canalización del control de código fuente. El argumento --config-file-path indica a GitHub Actions Importer que use los archivos de origen especificados en su lugar.

Al usar la opción --config-file-path con los subcomandos dry-run o migrate, GitHub Actions Importer hace coincidir el slug del repositorio con el trabajo representado por la opción --source-url para seleccionar la canalización. Usa config-file-path para extraer el archivo de origen especificado.

Ejemplo de audit

En este ejemplo, GitHub Actions Importer usa el archivo de configuración YAML especificado para realizar una auditoría.

gh actions-importer audit jenkins --output-dir path/to/output/ --config-file-path path/to/jenkins/config.yml

Para auditar una instancia de Jenkins mediante un archivo de configuración, el archivo de configuración debe tener el formato siguiente y cada valor repository_slug debe ser único:

source_files:
  - repository_slug: pipeline-name
    path: path/to/Jenkinsfile
  - repository_slug: multi-branch-pipeline-name
    branches:
      - branch: main
        path: path/to/Jenkinsfile
      - branch: node
        path: path/to/Jenkinsfile

Sintaxis admitida para las canalizaciones de Jenkins

En la tabla siguiente se muestra el tipo de propiedades que GitHub Actions Importer puede convertir actualmente. Para obtener más información sobre cómo la sintaxis de canalización de Jenkins se alinea con GitHub Actions, consulta "Migrar de Jenkins a GitHub Actions".

Para obtener información sobre los complementos de Jenkins compatibles, consulta el repositorio de github/gh-actions-importer.

Sintaxis admitida en las canalizaciones de Freestyle

JenkinsAcciones de GitHubEstado
plantilla de Dockerjobs.<job_id>.containerCompatible
buildjobsCompatibilidad parcial
entorno de compilaciónenvCompatibilidad parcial
desencadenadores de compilaciónonCompatibilidad parcial
generalrunnersCompatibilidad parcial

Sintaxis admitida para las canalizaciones de Jenkinsfile

JenkinsAcciones de GitHubEstado
dockerjobs.<job_id>.containerCompatible
fasejobs.<job_id>Compatible
agenterunnersCompatibilidad parcial
EnvironmentenvCompatibilidad parcial
fasesjobsCompatibilidad parcial
stepsjobs.<job_id>.stepsCompatibilidad parcial
DesencadenadoresonCompatibilidad parcial
whenjobs.<job_id>.ifCompatibilidad parcial
inputsinputsNo compatible
matrizjobs.<job_id>.strategy.matrixNo compatible
opcionesjobs.<job_id>.strategyNo compatible
parámetrosinputsNo compatible

Sintaxis de las variables de entorno

GitHub Actions Importer usa la asignación de la tabla siguiente para convertir las variables de entorno de Jenkins predeterminadas al equivalente más cercano de GitHub Actions.

JenkinsAcciones de GitHub
${BUILD_ID}${{ github.run_id }}
${BUILD_NUMBER}${{ github.run_id }}
${BUILD_TAG}${{ github.workflow }}-${{ github.run_id }}
${BUILD_URL}${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
${JENKINS_URL}${{ github.server_url }}
${JOB_NAME}${{ github.workflow }}
${WORKSPACE}${{ github.workspace }}

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.