You are viewing the Portuguese (Brazil) site, but your language preference is set to English. Switch to English site →

Menu

Implantar e liberar usando a CLI do Flex Plugins

O comando twilio flex:plugins:deploy automatiza o processo de upload do seu plugin para o Flex. Isso permite implantar seus plugins por meio da linha de comando, sem precisar carregá‐los manualmente usando uma GUI. Após uma implantação, seu plugin ainda não está ativado para todos os usuários em seu aplicativo Flex. Você precisa executar o comando release após a implantação para ativar quaisquer alterações.

O comando twilio flex:plugins:release é usado para alterar quais plugins estão ativos para seus usuários. Você pode agrupar vários plugins em uma versão, e pode reativar qualquer versão anterior para reverter as alterações.

Este guia inclui exemplos para implantar e liberar seus Flex Plugins.

Versões compatíveis da CLI

Você precisa instalar a versão mais recente da CLI do Flex Plugins para usar esses recursos. Se estiver migrando um plugin legado para usar a nova CLI, consulte nosso Guia de migração.

Implantação de uma versão principal de um plugin

twilio flex:plugins:deploy --major --changelog "Notes for this version" --description "Functionality of the plugin"

O comando deploy faz o seguinte:

  • Ele publica seu plugin como um Ativo Privadoque é acessível pela API Functions & Assets. Se quiser implantar seu plugin como um ativo público, você pode passar --public para o seu comando deploy.
  • Ele registra uma nova versão do plugin através da API Plugins. Para o exemplo acima, o sinalizador --major é passado. Isso cria uma nova versão principal do plugin (ex: v1 a v2) e armazena o changelog fornecido com sua nova versão. Se uma opção de versão (major, minor, ou patch) não for fornecida, o comando deploy assumirá como padrão uma nova versão de patch.
  • Ele atualiza o campo de versão no package.json de seu plugin para a nova versão.
  • Se o plugin estiver sendo implantado pela primeira vez, ele também o registrará como um novo plugin com a descrição fornecida. A opção description não precisa ser fornecida em implantações adicionais.

Como criar uma nova versão

A liberação de plugins é um processo de duas etapas que usa a API Plugins.

  1. Você cria uma Configuração de Plugin do Flex. Contém a lista de plugins que você deseja ativar e suas versões.
  2. Você cria uma versão do Flex com a configuração criada na etapa anterior.

O comando release da CLI de Plugins combina essas duas etapas para simplificar os cenários mais comuns.

A) Versão em uma etapa

Você pode criar uma versão listando cada plugin que deve estar ativo para seus usuários:

twilio flex:plugins:release --plugin example-plugin@1.0.0 --plugin additional-plugin@2.1.0 --name "Example 1" --description "Demonstrating use of twilio flex:plugins:release"

O comando release faz o seguinte:

Ao construir uma nova versão:

  • O argumento --plugin usa o plugin que você deseja ativar no formato plugin-name@version. Vários plugins podem ser agrupados em uma versão usando --plugin para cada plugin que deve ser habilitado.
  • Recomendamos configurar as opções --name e --description. Elas podem ser usadas para descrever o que foi alterado nesta versão, e esses detalhes serão exibidos no Dashboard de plugins. Essas são uma referência útil ao revisar seu histórico de versões ou optar por reimplantar uma versão anterior.

B) Separar sua configuração e versão

Uma nova configuração não precisa ser liberada imediatamente para os usuários. Em vez disso, você pode criar uma configuração primeiro e, em seguida, passar uma referência à configuração ao criar uma versão. Isso é semelhante ao processo que você usará para reimplantar uma versão anterior.

Primeiro, crie uma nova Configuração do Plugin do Flex:

twilio flex:plugins:create-configuration --name "Example config1" --description "Testing new plugins" --plugin plugin-test-example@1.0.0 --plugin <additional-plugin-name>@<version>​

Este comando criará uma nova configuração e retornará o SID do novo recurso. Você pode pesquisar o SID de uma configuração executando:

twilio flex:plugins:list:configurations​

Por fim, crie uma nova versão com a Configuração do plugin do Flex fornecida:

twilio flex:plugins:release --configuration-sid <Configuration Sid>

Liberando vários plugins

Por padrão, os comandos release e create-configuration mesclarão a lista de plugins que você fornece com os plugins que estão na configuração ativa. Esse comportamento pode ser alterado com o argumento --new. Suponha que você tenha dois plugins em operação: plugin-alpha@1.0.1 e plugin-beta@2.1.1. Uma nova versão v1.1.0 do plugin-alpha foi implantada e você está criando uma nova versão:

Sem --new (default)

twilio flex:plugins:release --plugin plugin-alpha@1.1.0 --name "Bumping Alpha" --description "Alpha and Beta both up-to-date"

Nesta versão, o plugin-alpha é atualizado para a versão fornecida no comando. O plugin-beta permanece ativado na versão ativa.

Com --new

twilio flex:plugins:release --new --plugin plugin-alpha@1.1.0 --name "Removing Beta" --description "Bumping Alpha and disabling Beta"

Nesta versão, somente os plugins fornecidos são adicionados à configuração desta versão. O resultado final será que somente o plugin-alpha está ativado.

O argumento --new deve ser usado se você estiver desabilitando um plugin que esteja na configuração ativa.

Gerenciar várias contas

A CLI do Flex Plugins usa o Account SID (SID da conta) da Twilio e o Auth Token (Token de autenticação) para implantar seus plugins.

Se você estiver implementando seus plugins em várias contas, será necessário fornecer credenciais para cada conta. Você pode criar vários perfis usando a CLI da Twilio para armazenar várias credenciais e, em seguida, passá‐las para seus comandos de algumas maneiras:

Usar um nome de perfil

Digamos que você tenha criado um perfil chamado stage. Você pode passar o nome do perfil no comando deploy para usar a conta designada.

twilio flex:plugins:deploy -p stage

Alternar perfis

Como alternativa, você pode alternar qual perfil está ativo usando o comando profiles da CLI da Twilio. Para ver a lista completa de perfis locais e escolher um novo perfil ativo, execute:

twilio profiles:list
twilio profiles:use <profile_name>

Variáveis de ambiente

Novos pares de credenciais AccountSid e AuthToken (Token de autenticação) também podem ser fornecidos como variáveis de ambiente com o comando deploy:

TWILIO_ACCOUNT_SID=ACxxx TWILIO_AUTH_TOKEN=abc123 twilio flex:plugins:deploy

Isso usará as credenciais fornecidas e as salvará no chaveiro. Se você tiver várias contas salvas e não fornecer credenciais com seu comando deploy, será solicitado que você selecione uma:

? Selecione um dos seguintes Account SID (SID da conta) (use as teclas de seta)
❯ AC0000000000000000000000000000000 
  AC0000000000000000000000000000001
  AC0000000000000000000000000000002

Você pode usar os comandos acima para vincular a implantação de plugin a um pipeline de CI/CD. Por exemplo:

#!/bin/bash
# Este script é executado em seu diretório de plugins
npm install
npm run test
npm run lint
TWILIO_ACCOUNT_SID=ACXXXX TWILIO_AUTH_TOKEN=pass123 twilio flex:plugins:deploy

Certifique‐se de manipular seu Account SID (SID da conta) e Auth Token (Token de autenticação) como variáveis de ambiente ou argumentos passados em seus scripts.

Próximas etapas

Classifique esta página:

Precisa de ajuda?

Às vezes, todos nós precisamos; a programação é difícil. Receba ajuda agora da nossa equipe de suporte, ou confie na sabedoria da multidão navegando pelo Stack Overflow Collective da Twilio ou buscando a tag Twilio no Stack Overflow.

Obrigado pelo seu feedback!

Selecione o(s) motivo(s) para seu feedback. As informações adicionais que você fornece nos ajudam a melhorar nossa documentação:

Enviando seu feedback...
🎉 Obrigado pelo seu feedback!
Algo deu errado. Tente novamente.

Obrigado pelo seu feedback!

thanks-feedback-gif