mirror of
https://github.com/EvolutionAPI/evolution-api.git
synced 2025-07-25 01:48:39 -06:00
chore: remove outdated issue templates for bug reports and feature requests in English and Portuguese to streamline the issue reporting process
feat: add new GitHub Actions workflow for deploying the application to an instance to automate deployment processes chore: remove old Docker image publishing workflows to clean up the repository and avoid confusion chore: add new configuration file for Doppler to manage environment variables more effectively
This commit is contained in:
parent
899bcd81a4
commit
9f27f37b3e
107
.github/ISSUE_TEMPLATE/-en--bug-report.yaml
vendored
107
.github/ISSUE_TEMPLATE/-en--bug-report.yaml
vendored
@ -1,107 +0,0 @@
|
||||
name: Bug Report
|
||||
description: Create a report to help us improve.
|
||||
labels:
|
||||
- bug
|
||||
- en
|
||||
# - help wanted
|
||||
# Automatically assign the issue to:
|
||||
# assignees: DavidsonGomes
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Welcome!
|
||||
description: |
|
||||
The issue tracker is only for reporting bugs and feature requests.
|
||||
For user-related support questions, please visit:
|
||||
- [Discord](https://evolution-api.com/discord)
|
||||
- [WhatsApp Group](https://evolution-api.com/whatsapp)
|
||||
<br/>
|
||||
|
||||
**DO NOT OPEN AN ISSUE FOR GENERAL SUPPORT QUESTIONS.**
|
||||
|
||||
options:
|
||||
- label: Yes, I have searched for similar issues on [GitHub](https://github.com/EvolutionAPI/evolution-api/issues) and found none.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What did you do?
|
||||
description: |
|
||||
How to write a good bug report?
|
||||
|
||||
- Respect the issue template as much as possible.
|
||||
- The title should be short and descriptive.
|
||||
- Explain the conditions that led you to report this issue: the context.
|
||||
- The context should lead to something, an idea or problem you are facing.
|
||||
- Be clear and concise.
|
||||
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
|
||||
placeholder: Describe the problem you encountered in detail.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What did you expect?
|
||||
placeholder: Describe what you expected to happen.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What did you observe instead of what you expected?
|
||||
placeholder: Explain what actually happens when you follow the steps above.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Screenshots/Videos
|
||||
placeholder: |
|
||||
If possible, add screenshots or videos that illustrate the problem. This can be extremely helpful in understanding the issue better.
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Which version of the API are you using?
|
||||
description: |
|
||||
Enter the version number found in the `version` property of the **package.json**.
|
||||
placeholder: Paste the version here.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: select
|
||||
attributes:
|
||||
label: What is your environment?
|
||||
options:
|
||||
- Windows
|
||||
- Linux
|
||||
- Mac
|
||||
- Docker
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Other environment specifications
|
||||
placeholder: 'Hardware/Software: [e.g., CPU, GPU]'
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: If applicable, paste the log output
|
||||
description: |
|
||||
Please attach any logs that might be related to the issue.
|
||||
If the logs contain sensitive information, consider sending them privately to one of the project maintainers.
|
||||
placeholder: Paste the application log here.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Notes
|
||||
description: Include any other information you think might be useful to understand or resolve the bug.
|
||||
validations:
|
||||
required: false
|
86
.github/ISSUE_TEMPLATE/-en--feature-request.yaml
vendored
86
.github/ISSUE_TEMPLATE/-en--feature-request.yaml
vendored
@ -1,86 +0,0 @@
|
||||
name: Feature Request
|
||||
description: Suggest ideas for the project.
|
||||
labels:
|
||||
- enhancement
|
||||
- en
|
||||
# Automatically assign the issue to:
|
||||
# assignees: DavidsonGomes
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Welcome!
|
||||
description: '**DO NOT OPEN FOR GENERAL SUPPORT QUESTIONS.**'
|
||||
|
||||
options:
|
||||
- label: Yes, I have searched for similar requests on [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) and found none.
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: What type of feature?
|
||||
description: |
|
||||
How to write a good feature request?
|
||||
|
||||
- Respect the issue template as much as possible.
|
||||
- The title should be short and descriptive.
|
||||
- Explain the conditions that led you to suggest this feature: the context.
|
||||
- The context should lead to something, an idea or problem you are facing.
|
||||
- Be clear and concise.
|
||||
- Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
|
||||
options:
|
||||
- Integration
|
||||
- Functionality
|
||||
- Endpoint
|
||||
- Database adjustment
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What is the motivation for the request?
|
||||
description: |
|
||||
What problem does the feature seek to solve?
|
||||
Clearly and in detail describe the functionality you want to be implemented.
|
||||
Explain how it fits into the context of the project.
|
||||
placeholder: Detailed description
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Usage Examples
|
||||
description: |
|
||||
Provide specific examples of how this functionality could be used.
|
||||
This can include scenarios or use cases where the feature would be particularly beneficial.
|
||||
placeholder: text - image - video - flowcharts
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: How should the feature be developed?
|
||||
description: |
|
||||
Should it be inserted directly into the code?
|
||||
Should it be built as a different application that acts as an extension of the API?
|
||||
For example: a `worker`?
|
||||
|
||||
Discuss how this new functionality could impact other parts of the project, if applicable.
|
||||
|
||||
---
|
||||
|
||||
If you have ideas on how this functionality could be implemented, please share them here.
|
||||
This is not mandatory, but it can be helpful for the development team.
|
||||
|
||||
placeholder: Insert feature ideas here
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Notes
|
||||
description: Any other information you believe is relevant to your request.
|
||||
placeholder: Insert your observations here.
|
||||
validations:
|
||||
required: false
|
108
.github/ISSUE_TEMPLATE/-pt--reportar-bug.yaml
vendored
108
.github/ISSUE_TEMPLATE/-pt--reportar-bug.yaml
vendored
@ -1,108 +0,0 @@
|
||||
name: Relatório de bug
|
||||
description: Crie um relatório para nos ajudar a melhorar.
|
||||
labels:
|
||||
- bug
|
||||
- pt-br
|
||||
# - help wanted
|
||||
# Atrubuir automaticamente a issue a:
|
||||
# assignees: DavidsonGomes
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: termos
|
||||
attributes:
|
||||
label: Bem-vido!
|
||||
description: |
|
||||
O rastreador de problemas é apenas para relatar bugs e solicitações de recursos.
|
||||
Para perguntas de suporte relacionadas ao usuário final, acesse:
|
||||
- [Discord](https://evolution-api.com/discord)
|
||||
- [Grupo do WhatsApp](https://evolution-api.com/whatsapp)
|
||||
<br/>
|
||||
|
||||
**NÃO ABRA UM PROBLEMA PARA PERGUNTAS GERAIS DE SUPORTE.**
|
||||
|
||||
options:
|
||||
- label: Sim, pesquisei problemas semelhantes no [GitHub](https://github.com/EvolutionAPI/evolution-api/issues) e não encontrei nenhum.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: O que você fez?
|
||||
description: |
|
||||
Como escrever um bom relatório de bug?
|
||||
|
||||
- Respeite o modelo de problema tanto quanto possível.
|
||||
- O título deve ser curto e descritivo.
|
||||
- Explique as condições que o levaram a reportar este problema: o contexto.
|
||||
- O contexto deve levar a algo, ideia ou problema que você está enfrentando.
|
||||
- Seja claro e conciso.
|
||||
- Formate suas mensagens para ajudar o leitor a se concentrar no que importa e entender a estrutura da sua mensagem, use [sintaxe Markdown](https://help.github.com/articles/github-flavored-markdown)
|
||||
placeholder: Descreva detalhadamente o problema que você encontrou.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: O que você esperava?
|
||||
placeholder: Descreva o que você esperava que acontecesse.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: O que vc observou ao invés do que esperava?
|
||||
placeholder: Explique o que realmente acontece quando você segue os passos acima.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Capturas de Tela/Vídeos
|
||||
placeholder: |
|
||||
Se possível, adicione capturas de tela ou vídeos que ilustrem o problema. Isso pode ser extremamente útil para entender melhor o problema.
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Qual versão da API você está usando?
|
||||
description: |
|
||||
Insira o número da sua versão que está na propriedade `version` do **package.json**.
|
||||
placeholder: Cole aqui a versão.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: select
|
||||
attributes:
|
||||
label: Qual é o seu ambiente?
|
||||
options:
|
||||
- Windows
|
||||
- Linux
|
||||
- Mac
|
||||
- Docker
|
||||
- Outro
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Outras expecificações do ambiente
|
||||
placeholder: 'Hardware/Software: [ex: CPU, GPU]'
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Se aplicável, cole a saída do log
|
||||
description: |
|
||||
Por favor, anexe os logs que possam estar relacionados ao problema.
|
||||
Se os logs contiverem informações sensíveis, considere enviá-los de forma privada para um dos mantenedores do projeto.
|
||||
placeholder: Cole aqui o log da aplicação
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Notas Adicionais
|
||||
description: Inclua aqui qualquer outra informação que você ache que possa ser útil para entender ou resolver o bug.
|
||||
validations:
|
||||
required: false
|
||||
|
@ -1,86 +0,0 @@
|
||||
name: Solicitação de recursos
|
||||
description: Sugira ideias para o projeto.
|
||||
labels:
|
||||
- enhancement
|
||||
- pt-br
|
||||
# Automatically assign the issue to:
|
||||
# assignees: DavidsonGomes
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: termos
|
||||
attributes:
|
||||
label: Bem-vindo!
|
||||
description: '**NÃO ABRA PARA PERGUNTAS GERAIS DE SUPORTE.**'
|
||||
|
||||
options:
|
||||
- label: Sim, pesquisei solicitações semelhantes no [GitHub](https://github.com/code-chat-br/whatsapp-api/issues) e não encontrei nenhum.
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Qual tipo de recurso?
|
||||
description: |
|
||||
Como escrever uma boa solicitação de bug?
|
||||
|
||||
- Respeite o modelo de problema tanto quanto possível.
|
||||
- O título deve ser curto e descritivo.
|
||||
- Explique as condições que o levaram a reportar este problema: o contexto.
|
||||
- O contexto deve levar a algo, ideia ou problema que você está enfrentando.
|
||||
- Seja claro e conciso.
|
||||
- Formate suas mensagens para ajudar o leitor a se concentrar no que importa e entender a estrutura da sua mensagem, use [sintaxe Markdown](https://help.github.com/articles/github-flavored-markdown)
|
||||
options:
|
||||
- Integração
|
||||
- Funcionalidade
|
||||
- Endpoint
|
||||
- Ajuste de banco de dados
|
||||
- Outro
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Qual a motivação para a solicitação?
|
||||
description: |
|
||||
Qual problema o recurso busca resolver?
|
||||
Descreva claramente e em detalhes a funcionalidade que você deseja que seja implementada.
|
||||
Explique como isso se encaixa no contexto do projeto.
|
||||
placeholder: Descrição detalhada
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Exemplos de Uso
|
||||
description: |
|
||||
Forneça exemplos específicos de como essa funcionalidade poderia ser utilizada.
|
||||
Isso pode incluir cenários ou casos de uso onde a funcionalidade seria particularmente benéfica.
|
||||
placeholder: texto - imagem - video - fluxogramas
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Como o recurso deve ser desenvolvido?
|
||||
description: |
|
||||
Deve ser inserido diretamente no código?
|
||||
Deve ser construído uma aplicação diferente que atuará como uma extenção da api?
|
||||
Por exemplo: um `worker`?
|
||||
|
||||
Discuta como essa nova funcionalidade poderia impactar outras partes do projeto, se aplicável.
|
||||
|
||||
---
|
||||
|
||||
Se você tem ideias sobre como essa funcionalidade pode ser implementada, por favor, compartilhe-as aqui.
|
||||
Isso não é obrigatório, mas pode ser útil para a equipe de desenvolvimento.
|
||||
|
||||
placeholder: Insira ideias para o recurso
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Notas Adicionais
|
||||
description: Qualquer outra informação que você acredita ser relevante para a sua solicitação.
|
||||
placeholder: Insira aqui as sua observções.
|
||||
validations:
|
||||
required: false
|
34
.github/workflows/deploy.yml
vendored
Normal file
34
.github/workflows/deploy.yml
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
name: Deploy Application
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Deploy to Instance
|
||||
uses: Burnett01/rsync-deployments@7.0.1
|
||||
with:
|
||||
switches: -avzr --delete --exclude=".git" --exclude=".env"
|
||||
path: ./
|
||||
remote_path: evolution
|
||||
remote_host: ${{ secrets.EC2_HOST }}
|
||||
remote_user: ${{ secrets.EC2_USER }}
|
||||
remote_key: ${{ secrets.EC2_SSH_KEY }}
|
||||
|
||||
- name: Start application with PM2
|
||||
uses: appleboy/ssh-action@v1.2.0
|
||||
with:
|
||||
host: ${{ secrets.EC2_HOST }}
|
||||
username: ${{ secrets.EC2_USER }}
|
||||
key: ${{ secrets.EC2_SSH_KEY }}
|
||||
script: |
|
||||
chmod +x run_evolution.sh
|
||||
./run_evolution.sh
|
48
.github/workflows/publish_docker_image.yml
vendored
48
.github/workflows/publish_docker_image.yml
vendored
@ -1,48 +0,0 @@
|
||||
name: Build Docker image
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "*.*.*"
|
||||
|
||||
jobs:
|
||||
build_deploy:
|
||||
name: Build and Deploy
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: atendai/evolution-api
|
||||
tags: type=semver,pattern=v{{version}}
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Build and push
|
||||
id: docker_build
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
- name: Image digest
|
||||
run: echo ${{ steps.docker_build.outputs.digest }}
|
@ -1,48 +0,0 @@
|
||||
name: Build Docker image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- develop
|
||||
|
||||
jobs:
|
||||
build_deploy:
|
||||
name: Build and Deploy
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: atendai/evolution-api
|
||||
tags: homolog
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Build and push
|
||||
id: docker_build
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
- name: Image digest
|
||||
run: echo ${{ steps.docker_build.outputs.digest }}
|
@ -1,48 +0,0 @@
|
||||
name: Build Docker image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
build_deploy:
|
||||
name: Build and Deploy
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: atendai/evolution-api
|
||||
tags: latest
|
||||
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Build and push
|
||||
id: docker_build
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
|
||||
- name: Image digest
|
||||
run: echo ${{ steps.docker_build.outputs.digest }}
|
3
doppler.yml
Normal file
3
doppler.yml
Normal file
@ -0,0 +1,3 @@
|
||||
setup:
|
||||
- project: evolution
|
||||
config: prd
|
Loading…
Reference in New Issue
Block a user