Migración desde canalizaciones de Bitbucket con el importador de acciones de GitHub

Información sobre la migración desde Bitbucket Pipelines con el Importador de Acciones de GitHub

Las instrucciones siguientes te guiarán por el proceso de configuración de un entorno para usar GitHub Actions Importer para migrar Bitbucket Pipelines a GitHub Actions.

Requisitos previos

Un entorno en el que puedas ejecutar contenedores basados en Linux e instalar las herramientas necesarias.
- Docker está instalado y funcionando.
- La CLI de GitHub está instalada.
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 Bitbucket Pipelines hasta GitHub Actions con GitHub Actions Importer.

No se admiten imágenes en un ECR privado de AWS.
No se admite la opción size de Bitbucket Pipelines
Las métricas que detallan el tiempo en cola de los trabajos no son compatibles con el comando forecast.

Los scripts posteriores de Bitbucket se admiten mediante GitHub Actions always() en combinación con la comprobación steps.<step_id>.conclusion del paso anterior. Para obtener más información, vea «Acceso a información contextual sobre ejecuciones de flujo de trabajo».

A continuación, se ofrece un ejemplo de uso de always() con steps.<step_id>.conclusion.

  - name: After Script 1
    run: |-
      echo "I'm after the script ran!"
      echo "We should be grouped!"
    id: after-script-1
    if: "${{ always() }}"
  - name: After Script 2
    run: |-
      echo "this is really the end"
      echo "goodbye, for now!"
    id: after-script-2
    if: "${{ steps.after-script-1.conclusion == 'success' && always() }}"

Tareas manuales

Determinadas construcciones de Bitbucket Pipelines deben migrarse manualmente. Entre ellas se incluyen las siguientes:

Repositorio seguro, área de trabajo y variables de implementación
Claves SSH

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

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

Bash

gh extension install github/gh-actions-importer

gh extension install github/gh-actions-importer

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 de la CLI configure se usa para establecer las credenciales y opciones necesarias para GitHub Actions Importer al trabajar con Bitbucket Pipelines y GitHub.

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.
Cree un token de acceso del área de trabajo para Bitbucket Pipelines. Para obtener más información, consulte Permisos de token de acceso al área de trabajo en la documentación de Bitbucket. El token debe tener el ámbito read de canalizaciones, proyectos y repositorios.
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 Bitbucket, 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 Bitbucket", escriba el token de acceso al área de trabajo que ha creado anteriormente y presione Entrar.
- En "Dirección URL base de la instancia", escriba la dirección URL de la instancia de Bitbucket y presione Entrar.
A continuación se muestra un ejemplo del comando configure:
```
$ gh actions-importer configure
✔ Which CI providers are you configuring?: Bitbucket
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 Bitbucket: ********************
✔ Base url of the Bitbucket instance: https://bitbucket.example.com
Environment variables successfully updated.
```
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
```

Realizar una auditoría de la instancia de Bitbucket

Puede usar el comando de auditoría para obtener una vista de alto nivel de las canalizaciones de una instancia de Bitbucket.

El comando de auditoría realiza los pasos siguientes.

Captura todas las canalizaciones de un área de trabajo.
Convierte la canalización en su flujo de trabajo equivalente de Acciones de GitHub.
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, ejecute el siguiente comando en el terminal reemplazando :workspace por el nombre del área de trabajo de Bitbucket que se va a auditar.

gh actions-importer audit bitbucket --workspace :workspace --output-dir tmp/audit

Opcionalmente, se puede proporcionar una opción --project-key al comando de auditoría para limitar los resultados a solo las canalizaciones asociadas a un proyecto.

En el siguiente comando :project_key de ejemplo se debe reemplazar por la clave del proyecto que se debe auditar. Las claves del proyecto se pueden encontrar en Bitbucket en la página de proyectos del área de trabajo.

gh actions-importer audit bitbucket --workspace :workspace --project-key :project_key --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 de la utilización

Puede 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 una instancia de Bitbucket.

Ejecución del comando de previsión

Para realizar una previsión del posible uso de Acciones de GitHub, ejecute el siguiente comando en el terminal y reemplace por :workspace el nombre del área de trabajo de Bitbucket para la previsión. De forma predeterminada, el Importador de Acciones de GitHub incluye los siete días anteriores en el informe de previsión.

gh actions-importer forecast bitbucket --workspace :workspace --output-dir tmp/forecast_reports

Previsión de proyectos

Para limitar la previsión a un proyecto, puede usar la opción --project-key. Reemplace el valor de por :project_key con la clave de proyecto del proyecto que se va a predecir.

gh actions-importer forecast bitbucket --workspace :workspace --project-key :project_key --output-dir tmp/forecast_reports

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 trabajos simultáneos describen la cantidad de trabajos que se ejecutan en un momento dado.

Realizar de un simulacro de importación

Puede usar el comando de simulacro para convertir una canalización de Bitbucket a un(os) flujo(s) de trabajo de GitHub Actions equivalente(s). 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.

Ejecución del comando de simulacro

Para realizar un simulacro de la migración de un Bitbucket Pipeline a GitHub Actions, ejecute el comando siguiente en su terminal reemplazando :workspace por el nombre del área de trabajo y :repo con el nombre del repositorio en Bitbucket.

gh actions-importer dry-run bitbucket --workspace :workspace --repository :repo --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».

Realizar la migración de producción

Puede usar el comando de migración para convertir una canalización de Bitbucket y abrir una solicitud de incorporación de cambios con el/los flujo(s) de trabajo de GitHub Actions equivalente(s).

Ejecución del comando migrate

Para migrar una canalización de Bitbucket a GitHub Actions, ejecuta el siguiente comando en el terminal y reemplaza los siguientes valores.

Reemplace el valor target-url por la dirección URL del repositorio GitHub.
Reemplace :repo por el nombre del propietario del repositorio en Bitbucket.
Reemplace :workspace por el nombre del área de trabajo.

gh actions-importer migrate bitbucket --workspace :workspace --repository :repo --target-url https://github.com/:owner/:repo --output-dir tmp/dry-run

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 bitbucket --workspace actions-importer --repository custom-trigger --target-url https://github.com/valet-dev-testing/demo-private --output-dir tmp/bitbucket
[2023-07-18 09:56:06] Logs: 'tmp/bitbucket/log/valet-20230718-165606.log'
[2023-07-18 09:56:24] Pull request: 'https://github.com/valet-dev-testing/demo-private/pull/55'

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 Enterprise Cloud.

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

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 Bitbucket Pipelines.

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 Bitbucket.

GITHUB_ACCESS_TOKEN: personal access token (classic) usado para crear solicitudes de incorporación de cambios con un flujo de trabajo transformado (requiere los ámbitos repo y workflow).
GITHUB_INSTANCE_URL: La dirección URL de la instancia de GitHub de destino. (por ejemplo, https://github.com)
BITBUCKET_ACCESS_TOKEN: El token de acceso del área de trabajo con ámbitos de lectura para canalización, proyecto y repositorio.

Estas variables de entorno se pueden especificar en un archivo .env.local que GitHub Actions Importer carga cuando se ejecuta. El archivo de distribución contiene un archivo .env.local.template que se puede usar para crear estos archivos.

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 dry-run o migrate.

De manera predeterminada, GitHub Actions Importer captura el contenido de la canalización de la instancia de Bitbucket. El argumento --source-file-path indica a GitHub Actions Importer que use la ruta de acceso del archivo de origen especificado en su lugar.

Por ejemplo:

gh actions-importer dry-run bitbucket --workspace :workspace --repository :repo --output-dir tmp/dry-run --source-file-path path/to/my/pipeline/file.yml

`--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 de la instancia de Bitbucket. El argumento --config-file-path indica a GitHub Actions Importer que use los archivos de origen especificados en su lugar.

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 bitbucket --workspace :workspace --output-dir tmp/audit --config-file-path "path/to/my/bitbucket/config.yml"

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

source_files:
  - repository_slug: repo_name
    path: path/to/one/source/file.yml
  - repository_slug: another_repo_name
    path: path/to/another/source/file.yml

Sintaxis admitida para Bitbucket Pipelines

En la tabla siguiente se muestra el tipo de propiedades que GitHub Actions Importer puede convertir actualmente.

Bitbucket	Acciones de GitHub	Estado
`after-script`	`jobs.<job_id>.steps[*]`	Compatible
`artifacts`	`actions/upload-artifact` & `download-artifact`	Admitido
`caches`	`actions/cache`	Admitido
`clone`	`actions/checkout`	Admitido
`condition`	`job.<job_id>.steps[*].run`	Admitido
`deployment`	`jobs.<job_id>.environment`	Admitido
`image`	`jobs.<job_id>.container`	Admitido
`max-time`	`jobs.<job_id>.steps[*].timeout-minutes`	Compatible
`options.docker`	None	Compatible
`options.max-time`	`jobs.<job_id>.steps[*].timeout-minutes`	Admitido
`parallel`	`jobs.<job_id>`	Admitido
`pipelines.branches`	`on.push`	Admitido
`pipelines.custom`	`on.workflow_dispatch`	Admitido
`pipelines.default`	`on.push`	Admitido
`pipelines.pull-requests`	`on.pull_requests`	Admitido
`pipelines.tags`	`on.tags`	Admitido
`runs-on`	`jobs.<job_id>.runs-on`	Admitido
`script`	`job.<job_id>.steps[*].run`	Admitido
`services`	`jobs.<job_id>.service`	Admitido
`stage`	`jobs.<job_id>`	Admitido
`step`	`jobs.<job_id>.steps[*]`	Admitido
`trigger`	`on.workflow_dispatch`	Compatible
`fail-fast`	None	No admitidas
`oidc`	None	No admitidas
`options.size`	None	No admitidas
`size`	None	No admitidas

Asignación de variables de entorno

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

Bitbucket	Acciones de GitHub
`CI`	`true`
`BITBUCKET_BUILD_NUMBER`	`${{ github.run_number }}`
`BITBUCKET_CLONE_DIR`	`${{ github.workspace }}`
`BITBUCKET_COMMIT`	`${{ github.sha }}`
`BITBUCKET_WORKSPACE`	`${{ github.repository_owner }}`
`BITBUCKET_REPO_SLUG`	`${{ github.repository }}`
`BITBUCKET_REPO_UUID`	`${{ github.repository_id }}`
`BITBUCKET_REPO_FULL_NAME`	`${{ github.repository_owner }}`/`${{ github.repository }}`
`BITBUCKET_BRANCH`	`${{ github.ref }}`
`BITBUCKET_TAG`	`${{ github.ref }}`
`BITBUCKET_PR_ID`	`${{ github.event.pull_request.number }}`
`BITBUCKET_PR_DESTINATION_BRANCH`	`${{ github.event.pull_request.base.ref }}`
`BITBUCKET_GIT_HTTP_ORIGIN`	`${{ github.event.repository.clone_url }}`
`BITBUCKET_GIT_SSH_ORIGIN`	`${{ github.event.repository.ssh_url }}`
`BITBUCKET_EXIT_CODE`	`${{ job.status }}`
`BITBUCKET_STEP_UUID`	`${{ job.github_job }}`
`BITBUCKET_PIPELINE_UUID`	`${{ github.workflow }}`
`BITBUCKET_PROJECT_KEY`	`${{ github.repository_owner }}`
`BITBUCKET_PROJECT_UUID`	`${{ github.repository_owner }}`
`BITBUCKET_STEP_TRIGGERER_UUID`	`${{ github.actor_id }}`
`BITBUCKET_SSH_KEY_FILE`	`${{ github.workspace }}/.ssh/id_rsa`
`BITBUCKET_STEP_OIDC_TOKEN`	Sin asignación
`BITBUCKET_DEPLOYMENT_ENVIRONMENT`	Sin asignación
`BITBUCKET_DEPLOYMENT_ENVIRONMENT_UUID`	Sin asignación
`BITBUCKET_BOOKMARK`	Sin asignación
`BITBUCKET_PARALLEL_STEP`	Sin asignación
`BITBUCKET_PARALLEL_STEP_COUNT`	Sin asignación

Variables del sistema

Las variables del sistema usadas en las tareas se transforman en las variables del shell de Bash equivalente y se supone que están disponibles. Por ejemplo, ${system.<variable.name>} se transformará en $variable_name. Se recomienda comprobarlo para garantizar el correcto funcionamiento del flujo de trabajo.

Aviso legal

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.

Migración desde canalizaciones de Bitbucket con el importador de acciones de GitHub

En este artículo