Utilitários de Pipeline CI/CD BotCity¶

O BotCity oferece suporte nativo ao uso do GitHub Actions por meio do BotCity Actions - Bots.

Para suportar diversas outras tecnologias de pipeline CI/CD, fornecemos os scripts Bash detalhados abaixo.

Dica

Confira os exemplos disponíveis para GitHub Actions, Azure Pipelines, Woodpecker CI, BitBucket Pipelines, GitLab CI e Jenkins clicando aqui.

Script de Gerenciamento de Bots¶

O bot.sh é um script Bash versátil projetado para lidar com tarefas comuns de gerenciamento de bots, incluindo deploy, atualização e release de bots por meio da API do BotCity Orquestrador.

Esse script simplifica as operações de gerenciamento de bots em pipelines CI/CD, fornecendo uma interface de linha de comando fácil de usar.

Funcionalidades¶

Deploy/Implantar um bot: Fazer upload e implantar uma nova versão de um bot.
Update/Atualizar um bot: Atualizar a versão de um bot existente.
Release/Liberar um bot: Liberar uma versão de um bot na plataforma BotCity Orquestrador.

Requisitos¶

cURL: Utilizado para enviar requisições HTTP.
Variáveis de Ambiente: É necessário definir as seguintes variáveis de ambiente para autenticação:
SERVER: URL do servidor da API do BotCity Orquestrador.
LOGIN: Seu login na API do BotCity Orquestrador.
KEY: Sua chave da API do BotCity Orquestrador.

Info

Você pode encontrar seu login e chave da API do Orquestrador no menu Ambiente do Desenvolvedor.
Mais informações disponíveis em nossa documentação.

Uso¶

O script suporta três subcomandos: deploy, update e release. Abaixo estão as instruções detalhadas para cada um.

Deploy/Implantar um Bot¶

Para fazer o deploy de um bot, use o subcomando deploy. Isso fará upload e deploy/implantação do bot no BotCity Orquestrador.

Parâmetros Obrigatórios:

-version: A versão do bot.
-botFile: O caminho para o arquivo do bot.
-botId: O identificador único do bot.
-type: O tipo de tecnologia do bot (por exemplo, python, java, etc.).
-repository: (Opcional) O rótulo do repositório. O padrão é DEFAULT, caso não seja especificado.

./bot.sh deploy -version "1.0.0" -botFile "/caminho/para/bot.zip" -botId "MeuBotId" -type "python" -repository "DEFAULT"

Atualizar um Bot¶

Para atualizar um bot, use o subcomando update. Esse comando atualizará a versão do bot especificado no BotCity Orquestrador.

Parâmetros Obrigatórios:

-version: A versão do bot.
-botFile: O caminho para o arquivo do bot.
-botId: O identificador único do bot.

./bot.sh update -version "1.0.0" -botFile "/caminho/para/bot.zip" -botId "MeuBotId"

Lançar um Bot¶

Para lançar um bot, use o subcomando release. Esse subcomando requer apenas o ID do bot e a versão.

Parâmetros Obrigatórios:

-version: A versão do bot.
-botId: O identificador único do bot.

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

Exemplos de Comandos¶

Exemplo de Implantação¶

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

Exemplo de Atualização¶

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

Exemplo de Lançamento¶

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

Tratamento de Erros¶

Se os parâmetros obrigatórios não forem fornecidos, o script exibirá uma mensagem de uso e será encerrado.
Se a solicitação à API falhar (código de status diferente de 200), uma mensagem de erro será exibida com detalhes.

Para mais informações¶

Visite o projeto no GitHub, envie issues ou pull requests para melhorar este script e revise os detalhes de licenciamento clicando aqui.