Acerca de la migración desde CircleCI 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 CircleCI a GitHub Actions.
Requisitos previos
-
Una cuenta u organización de CircleCI con proyectos y canalizaciones que quieras convertir en flujos de trabajo de GitHub Actions.
-
Acceso para crear un token de API personal de CircleCI para tu cuenta u organización.
-
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 CircleCI a GitHub Actions con GitHub Actions Importer.
- No se admite el almacenamiento en caché automático entre trabajos de diferentes flujos de trabajo.
- El comando
audit
solo se admite cuando se usa una cuenta de organización. Sin embargo, los comandosdry-run
ymigrate
se pueden usar con una cuenta de organización o de usuario.
Tareas manuales
Algunas construcciones de CircleCI deben migrarse manualmente. Entre ellas se incluyen las siguientes:
- Contextos
- Variables de entorno de nivel de proyecto
- Propiedades de trabajo desconocidas
- Orbs desconocidos
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 configure
de la CLI se usa para establecer las credenciales y opciones necesarias para GitHub Actions Importer al trabajar con CircleCI y GitHub.
-
Crea un GitHub personal access token. 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.
-
Crea un token de API personal de CircleCI. Para obtener más información, consulta Administración de tokens de API en la documentación de CircleCI.
Después de crear el token, cópialo y guárdalo en una ubicación segura para utilizarlo más adelante.
-
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
CircleCI
, presiona Espacio para seleccionarlo y, a continuación, presiona Entrar. - En "Personal access token para GitHub", escribe el valor del personal access token que has creado anteriormente y presiona Entrar.
- En "Dirección URL base de la instancia de GitHub", escribe la dirección URL de tu instancia de GitHub Enterprise Server y presiona Entrar.
- En "Personal access token para CircleCI", escribe el valor del token de API personal de CircleCI que has creado anteriormente y presiona Entrar.
- En "Dirección URL base de la instancia de CircleCI", presiona Entrar para aceptar el valor predeterminado (
https://circleci.com
). - En "Nombre de la organización de CircleCI", escribe el nombre de la organización de CircleCI y presiona Entrar.
A continuación se muestra un ejemplo del comando
configure
:$ gh actions-importer configure ✔ Which CI providers are you configuring?: CircleCI 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 CircleCI: ******************** ✔ Base url of the CircleCI instance: https://circleci.com ✔ CircleCI organization name: mycircleciorganization Environment variables successfully updated.
- En "¿Qué proveedores de CI estás configurando?", usa las teclas de dirección para seleccionar
-
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 CircleCI
Puedes usar el comando audit
para obtener una vista general de todos los proyectos de una organización de CircleCI.
El comando audit
realiza los pasos siguientes:
- Captura todos los proyectos definidos en una organización de CircleCI.
- Convierte cada canalización en su flujo de trabajo equivalente de GitHub Actions.
- 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 una organización de CircleCI, ejecuta el comando siguiente en el terminal:
gh actions-importer audit circle-ci --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 ha configurado mal y no es válida en Bamboo.
- 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 uso potencial de GitHub Actions
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 CircleCI.
Ejecución del comando de previsión
Para realizar una previsión del uso potencial de 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 circle-ci --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 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 CircleCI. 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 CircleCI
Puedes usar el comando dry-run
para convertir una canalización de CircleCI 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 del proyecto de CircleCI a GitHub Actions, ejecuta el comando siguiente en el terminal, reemplazando my-circle-ci-project
por el nombre del proyecto de CircleCI.
gh actions-importer dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project my-circle-ci-project
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 CircleCI
Puedes usar el comando migrate
para convertir una canalización de CircleCI 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 CircleCI 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-circle-ci-project
por el nombre del proyecto de CircleCI.
gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-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 circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project
[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 Enterprise Server.
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 Server.
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 CircleCI.
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 CircleCI:
GITHUB_ACCESS_TOKEN
: personal access token usado para crear solicitudes de incorporación de cambios con un flujo de trabajo convertido (requiere los ámbitosrepo
yworkflow
).GITHUB_INSTANCE_URL
: dirección URL de la instancia de GitHub de destino (por ejemplo,https://github.com
).CIRCLE_CI_ACCESS_TOKEN
: token de API personal de CircleCI que se usa para autenticarse con la instancia de CircleCI.CIRCLE_CI_INSTANCE_URL
: dirección URL de la instancia de CircleCI (por ejemplo,https://circleci.com
). Si la variable se deja sin establecer,https://circleci.com
se usa como valor predeterminado.CIRCLE_CI_ORGANIZATION
: nombre de la organización de la instancia de CircleCI.CIRCLE_CI_PROVIDER
: ubicación donde se almacena el archivo de origen de la canalización (por ejemplo,github
). Actualmente, solo se admite GitHub.CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN
: (opcional) personal access token que se usa para autenticarse con la instancia de GitHub de origen (requiere el ámbitorepo
). Si no se proporciona, se usa el valor deGITHUB_ACCESS_TOKEN
en su lugar.CIRCLE_CI_SOURCE_GITHUB_INSTANCE_URL
: (opcional) dirección URL de la instancia de GitHub de origen. Si no se proporciona, se usa el valor deGITHUB_INSTANCE_URL
en su lugar.
Estas variables de entorno se pueden especificar en un archivo .env.local
que GitHub Actions Importer carga cuando se ejecuta.
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 migrate
.
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.
Por ejemplo:
gh actions-importer dry-run circle-ci --output-dir ./output/ --source-file-path ./path/to/.circleci/config.yml
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
.
--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.
El argumento --config-file-path
también se puede usar para especificar a qué repositorio se debe migrar una acción compuesta convertida.
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 circle-ci --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml
Para auditar una instancia de CircleCI 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: circle-org-name/circle-project-name
path: path/to/.circleci/config.yml
- repository_slug: circle-org-name/some-other-circle-project-name
path: path/to/.circleci/config.yml
Ejemplo de simulacro
En este ejemplo, GitHub Actions Importer usa el archivo de configuración YAML especificado como archivo de origen para realizar un simulacro.
Para seleccionar la canalización, se hace coincidir el elemento repository_slug
del archivo de configuración con el valor de las opciones --circle-ci-organization
y --circle-ci-project
. A continuación, se usa path
para extraer el archivo de origen especificado.
gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml
Especificación del repositorio de acciones compuestas convertidas
El GitHub Actions Importer usa el archivo YAML que se proporciona al argumento --config-file-path
para determinar el repositorio al que se migran las acciones compuestas convertidas.
Para empezar, ejecuta una auditoría sin el argumento --config-file-path
:
gh actions-importer audit circle-ci --output-dir ./output/
La salida de este comando contendrá un archivo denominado config.yml
que incluye una lista de todas las acciones compuestas que convirtió el GitHub Actions Importer. Por ejemplo, el archivo config.yml
podría tener el contenido siguiente:
composite_actions:
- name: my-composite-action.yml
target_url: https://github.com/octo-org/octo-repo
ref: main
Puedes usar este archivo para especificar a qué repositorio y referencia se debe agregar un flujo de trabajo reutilizable o una acción compuesta. A continuación, puedes usar el argumento --config-file-path
para proporcionar el archivo config.yml
al GitHub Actions Importer. Por ejemplo, puedes usar este archivo al ejecutar un comando migrate
para abrir una solicitud de cambios para cada repositorio único definido en el archivo de configuración:
gh actions-importer migrate circle-ci --circle-ci-project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo
--include-from
Puedes usar el argumento --include-from
con el subcomando audit
.
El argumento --include-from
especifica un archivo que contiene una lista delimitada por líneas de los repositorios que se van a incluir en la auditoría de una organización de CircleCI. Los repositorios que no están incluidos en el archivo se excluyen de la auditoría.
Por ejemplo:
gh actions-importer audit circle-ci --output-dir ./output/ --include-from repositories.txt
El archivo proporcionado para este parámetro debe ser una lista delimitada por líneas de repositorios, por ejemplo:
repository_one
repository_two
repository_three
Sintaxis admitida para las canalizaciones de CircleCI
En la tabla siguiente se muestra el tipo de propiedades que GitHub Actions Importer puede convertir actualmente.
Canalizaciones de CircleCI | Acciones de GitHub | Estado |
---|---|---|
desencadenadores cron |
| Compatible |
Environment |
| Compatible |
ejecutores |
| Compatible |
jobs |
| Compatible |
trabajo |
| Compatible |
matriz |
| Compatible |
parámetros |
| Compatible |
steps |
| Compatible |
cuando, a menos que |
| Compatible |
Desencadenadores |
| Compatible |
ejecutores |
| Se admite parcialmente |
Orbes |
| Se admite parcialmente |
ejecutores |
| No compatible |
instalar | No aplicable | No compatible |
version | No aplicable | No compatible |
Para obtener más información sobre las asignaciones de conceptos y orbes compatibles de CircleCI, consulta el repositorio de github/gh-actions-importer
.
Asignación de variables de entorno
GitHub Actions Importer usa la asignación de la tabla siguiente para convertir las variables de entorno de CircleCI predeterminadas al equivalente más cercano de GitHub Actions.
CircleCI | Acciones de GitHub |
---|---|
CI | $CI |
CIRCLE_BRANCH | ${{ github.ref }} |
CIRCLE_JOB | ${{ github.job }} |
CIRCLE_PR_NUMBER | ${{ github.event.number }} |
CIRCLE_PR_REPONAME | ${{ github.repository }} |
CIRCLE_PROJECT_REPONAME | ${{ github.repository }} |
CIRCLE_SHA1 | ${{ github.sha }} |
CIRCLE_TAG | ${{ github.ref }} |
CIRCLE_USERNAME | ${{ github.actor }} |
CIRCLE_WORKFLOW_ID | ${{ github.run_number }} |
CIRCLE_WORKING_DIRECTORY | ${{ github.workspace }} |
<< pipeline.id >> | ${{ github.workflow }} |
<< pipeline.number >> | ${{ github.run_number }} |
<< pipeline.project.git_url >> | $GITHUB_SERVER_URL/$GITHUB_REPOSITORY |
<< pipeline.project.type >> | github |
<< pipeline.git.tag >> | ${{ github.ref }} |
<< pipeline.git.branch >> | ${{ github.ref }} |
<< pipeline.git.revision >> | ${{ github.event.pull_request.head.sha }} |
<< pipeline.git.base_revision >> | ${{ github.event.pull_request.base.sha }} |
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.