Teste e publicação utilizando o Add-on Studio

Testes em ambiente local

Antes de publicar o add-on, é fundamental validar seu funcionamento em um ambiente de testes local. Isso permite identificar e corrigir possíveis erros antes da distribuição, garantindo maior estabilidade e compatibilidade.

Para implantar e testar o add-on localmente, siga os passos abaixo:

• Certifique-se de que a variável serverFolder está corretamente configurada no arquivo build.gradle. Essa variável define o caminho do servidor WildFly, essencial para o deploy local.
• Habilite o modo debug, para isso siga o passo a passo:
  • Acesse a pasta do WildFly: Wildfly > bin.
  • Edite o arquivo standalone.conf.bat.
  • Remova o comentário do seguinte argumento:

  - # Sample JPDA settings for remote socket debugging
  - JAVA_OPTS="$JAVA_OPTS -agentlib:jdwp=transport=dt_socket,address=8787,server=y,suspend=n"
  

• Execute o comando de deploy:

./gradlew clean deployAddon

• Verifique se o add-on foi implantado corretamente acessando o ambiente local do Sankhya Om e conferindo se as funcionalidades desenvolvidas estão disponíveis e operando conforme esperado. Caso encontre erros, revise os logs do WildFly para identificar possíveis falhas e ajustes necessários.

📘

Dica:

Para evitar conflitos entre sistemas operacionais no desenvolvimento, utilize variáveis de ambiente para definir o caminho do WildFly em serverFolder.

Publicação do add-on via IDE

Após testar e validar o add-on localmente, o próximo passo é publicá-lo na Área do Desenvolvedor para que possa ser distribuído e instalado pelos clientes. Para isso, execute o seguinte comando, substituindo <email snkID com acesso a Áreadev> e <senha> pelas credenciais do seu Sankhya ID com acesso à Área do Desenvolvedor:

Linux:

./gradlew clean publishAddon -Pusuario=<email snkID com acesso a Áreadev> -Psenha=<senha> -PprivateKey="/CAMINHO/DA/CHAVE/DE/ASSINATURA.KEY"

Windows

./gradlew clean publishAddon -Pusuario=<email snkID com acesso a Áreadev> -Psenha=<senha> -PprivateKey="C:\\CAMINHO\\DA\\CHAVE\\DE\\ASSINATURA.KEY"

A solução só pode ser publicada e disponibilizada no Sankhya Place através da IDE se já tiver sido publicada manualmente pelo menos uma vez na Área do Desenvolvedor.

Para isso, basta acrescentar o argumento -PpublishPlace=true aos comandos listados acima. Caso tenha dúvidas sobre o processo de primeira publicação, consulte o artigo "Publicando Add-ons através da Área do Desenvolvedor" para obter mais detalhes.

📘

Observação:

A variável -PprivateKey é obrigatória e indica o local onde a chave de assinatura do add-on está armazenada. Para saber como gerá-la, consulte este artigo.

Boas práticas para a publicação

✅ Utilize variáveis de ambiente para armazenar credenciais sensíveis, evitando expô-las diretamente no código ou em scripts.
✅ Verifique a compatibilidade do add-on com a versão mínima do Sankhya Om configurada em plataformaMinima.
✅ Confirme que a appKey está definida corretamente no build.gradle, pois esse campo é obrigatório para a publicação.
✅Certifique que todos os campos necessários para a publicação do add-on estão devidamente preenchidos
✅ Revise os logs da publicação para garantir que o processo foi concluído sem erros.

Uma vez publicado, o add-on estará disponível para instalação nos ambientes autorizados.

Obs.: Este projeto permite a criação de uma pipeline em seu serviço de integração contínua preferido (como GitLab, Azure, GitHub, entre outros).