Ir para o conteúdo

Funcionalidades automatizadas

Para suportar diversas tecnologias de pipeline CI/CD, fornecemos os scripts Bash, o qual vamos entendê-lo e utilizá-lo como exemplo nesse treinamento.

Dica

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

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, update e release de bots por meio da API do Orquestrador BotCity.

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

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

Requisitos

  • cURL: Utilitário para enviar requisições HTTP.
  • Variáveis de Ambiente: Para autenticação e comunicação segura com o servidor do Orquestrador BotCity:
  • SERVER: URL do servidor (https://developers.botcity.dev)
  • LOGIN: Seu login (valor encontrado em Amb. do desenvolvedor)
  • KEY: Sua chave (valor encontrado em Amb. do desenvolvedor)

Info

Mais informações disponíveis em nossa documentação.

Comandos

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

Implantar um bot | Deploy

A implantação (ou deploy) consiste em subir uma nova versão do projeto para o Orquestrador da BotCity, para isso utilizamos o subcomando deploy.

Exemplo: Tenho a versão do bot 1.0.0 e quero subir a nova versão 1.0.1.

Parâmetros Obrigatórios:

  • -version: A nova versão do bot.
  • -botFile: O caminho para o arquivo .zip do bot.
  • -botId: O identificador único do bot no Orquestrador BotCity.
  • -type: O tipo de tecnologia que o bot foi desenvolvido (por exemplo, python, java, etc.).
  • -repository: (Opcional quando o repositório for DEFAULT) O rótulo do repositório.
./bot.sh deploy 
-version "1.0.1" 
-botFile "./bot.zip" 
-botId "MeuBotId" 
-type "python"
-repository "DEV"

Atenção

O parâmetro -version do subcomando deploy deve conter o valor de uma nova versão, não pode ser igual a uma versão já existente no Orquestrador BotCity.

Atualizar um bot | Update

A atualização (ou update) de um bot consiste sobrescrever uma versão já existente no Orquestrador BotCity, para isso utilizamos o subcomando update.

Exemplo: Tenho a versão do bot 1.0.0 e quero sobrescrever essa versão com o novo projeto.

Parâmetros Obrigatórios:

  • -version: A versão existente do bot no Orquestrador BotCity.
  • -botFile: O caminho para o arquivo .zip do bot.
  • -botId: O identificador único do bot no Orquestrador BotCity.
./bot.sh update 
-version "1.0.0" 
-botFile "./bot.zip" 
-botId "MeuBotId"

Liberar um bot | Release

A liberação (ou release) de um bot consiste definir qual versão já existente no Orquestrador BotCity será utilizada no momento de execução pelo Runner, para isso utilizamos o subcomando update.

Exemplo: Tenho a versão do bot 1.0.1 e quero marcá-la como release.

Parâmetros Obrigatórios:

  • -version: A versão existente do bot no Orquestrador BotCity.
  • -botId: O identificador único do bot no Orquestrador BotCity.
./bot.sh release 
-version "1.0.1" 
-botId "MeuBotId"