Utilidades de Pipeline CI/CD de BotCity¶

BotCity admite de forma nativa el uso de GitHub Actions a través de BotCity Actions - Bots.

Para admitir muchas otras tecnologías de pipeline CI/CD, proporcionamos los scripts Bash detallados a continuación.

Tip

Revisa los ejemplos disponibles para GitHub Actions, Azure Pipelines, Woodpecker CI, BitBucket Pipelines, GitLab CI y Jenkins haciendo clic aquí.

Script de Gestión de Bots¶

bot.sh es un script Bash versátil diseñado para manejar tareas comunes de gestión de bots, incluyendo la implementación, actualización y lanzamiento de bots a través de la API de BotCity Orchestrator.

Este script simplifica las operaciones de gestión de bots en pipelines CI/CD proporcionando una interfaz de línea de comandos fácil de usar.

Funcionalidades¶

Deploy/Implementar un bot: Subir e implementar una nueva versión de un bot.
Update/Actualizar un bot: Actualizar la versión de un bot existente.
Release/Lanzar un bot: Liberar una versión de un bot en la plataforma BotCity Orchestrator.

Requisitos¶

cURL: Utilizado para enviar solicitudes HTTP.
Variables de Entorno: Debe configurar las siguientes variables de entorno para la autenticación:
SERVER: URL del servidor de la API de BotCity Orchestrator.
LOGIN: Su login de la API de BotCity Orchestrator.
KEY: Su clave de la API de BotCity Orchestrator.

Info

Puede encontrar su login y clave de la API de Orchestrator en el menú Ambiente de Desarrollo.
Más información disponible en nuestra documentación.

Uso¶

El script admite tres subcomandos: deploy, update y release. A continuación, se presentan las instrucciones detalladas para cada uno.

Implementar un Bot¶

Para implementar un bot, use el subcomando deploy. Esto subirá e implementará el bot en BotCity Orchestrator.

Parámetros Obligatorios:

-version: La versión del bot.
-botFile: La ruta del archivo del bot.
-botId: El identificador único del bot.
-type: El tipo de tecnología del bot (por ejemplo, python, java, etc.).
-repository: (Opcional) La etiqueta del repositorio. Por defecto, es DEFAULT si no se especifica.

./bot.sh deploy -version "1.0.0" -botFile "/ruta/al/bot.zip" -botId "MiBotId" -type "python" -repository "DEFAULT"

Actualizar un Bot¶

Para actualizar un bot, use el subcomando update. Este comando actualizará la versión del bot especificado en BotCity Orchestrator.

Parámetros Obligatorios:

-version: La versión del bot.
-botFile: La ruta del archivo del bot.
-botId: El identificador único del bot.

./bot.sh update -version "1.0.0" -botFile "/ruta/al/bot.zip" -botId "MiBotId"

Lanzar un Bot¶

Para lanzar un bot, use el subcomando release. Este subcomando solo requiere el ID del bot y la versión.

Parámetros Obligatorios:

-version: La versión del bot.
-botId: El identificador único del bot.

./bot.sh release -version "1.0.0" -botId "MiBotId"

Ejemplos de Comandos¶

Ejemplo de Implementación¶

./bot.sh deploy -version "1.2.0" -botFile "/home/usuario/bot.zip" -botId "MiBotGenial" -type "python" -repository "ProductionRepo"

Ejemplo de Actualización¶

./bot.sh update -version "1.2.0" -botFile "/home/usuario/bot_update.zip" -botId "MiBotGenial"

Ejemplo de Lanzamiento¶

./bot.sh release -version "1.2.0" -botId "MiBotGenial"

Manejo de Errores¶

Si no se proporcionan los parámetros obligatorios, el script mostrará un mensaje de uso y se cerrará.
Si la solicitud a la API falla (código de estado diferente de 200), se mostrará un mensaje de error con detalles.

Para más información¶

Visite el proyecto en GitHub, envíe issues o pull requests para mejorar este script y revise los detalles de licencia haciendo clic aquí.