Merge pull request #1 from RITSI/develop

Template preparada

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,74 @@
+name: Reporte de bugs
+description: Reporta un bug para ayudar a mejorar el bot
+title: "[BUG]"
+labels: ["bug :bug:"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Gracias por reportar problemas en BOTSI!
+        
+        Por favor, rellena la siguiente plantilla para ayudarnos a identificar y resolver el problema.
+
+        Para hacerlo más fácil, por favor, introduce la información detallada a continuación.
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Pasos para reproducir el problema
+      value: |
+        1. 
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behaviour
+    attributes:
+      label: Comportamiento esperado
+      description: ¿Qué esperabas que sucediera?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behaviour
+    attributes:
+      label: Comportamiento actual
+      description: ¿Qué sucedió en realidad?
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "### Configuración"
+
+  - type: input
+    id: operating-system
+    attributes:
+      label: Sistema operativo
+    validations: 
+      required: true
+
+  - type: textarea
+    id: versions
+    attributes:
+      label: Versión de Python y de los paquetes
+      description: Copia la salida del comando `$ python -m telegram` y pégala aquí. Se formateará automáticamente en código, por lo que no es necesario que uses comillas invertidas.
+      render: Shell
+    validations: 
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Copia los logs del bot y pégalos aquí. Se formateará automáticamente en código, por lo que no es necesario que uses comillas invertidas.
+      render: Python
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Contenido adicional
+      description: ¿Hay algo más que debamos saber?

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,37 @@
+name: Feature Request
+description: Sugiérenos una nueva característica para el bot
+title: "[FEATURE]"
+labels: ["enhancement"]
+
+body:
+  - type: textarea
+    id: related-problem
+    attributes:
+      label: "Qué tipo de característica te gustaría que se añadiera? ¿Qué problema quieres resolver?"
+      description: "Una descripción clara y concisa de lo que te gustaría que sucediera."
+      placeholder: "Ejemplo: Me gustaría que el bot pudiera hacer X porque no hay ninguna forma de hacerlo."
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: "Describe la solución que te gustaría que se implementara"
+      description: "Una descripción clara y concisa de lo que quieres que suceda."
+      placeholder: "Ejemplo: Creo que sería bueno si se añade la función Y para poder hacer X."
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: "Describe las alternativas que has considerado"
+      description: "Una descripción clara y concisa de cualquier solución o característica alternativa que hayas considerado."
+      placeholder: "Ejemplo: Considero que Z podría dar con la solución, pero no es tan buena como Y porque..."
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: "Contenido adicional"
+      description: "Agregue cualquier otro contenido o capturas de pantalla sobre la solicitud de función aquí."
+      placeholder: "Ejemplo: Aquí hay una captura de pantalla de mi oso de peluche."

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,64 @@
+name: Dudas
+description: Obtén ayuda con el bot
+title: "[DUDA]"
+labels: ["question"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Hola, ¿tienes alguna duda? Estaré encantado de ayudarte. Por favor, asegúrate de que no se haya abierto ya una pregunta similar.
+
+  - type: textarea
+    id: issue-faced
+    attributes:
+      label: "Problema que estás teniendo"
+      description: "Describe el problema que estás teniendo. Por favor, sé lo más específico posible."
+    validations:
+      required: true
+
+  - type: textarea
+    id: traceback
+    attributes:
+      label: "Trazas de error"
+      description: "Si hay algún error, pégalo aquí. Se formateará automáticamente en código (python), por lo que no es necesario que uses comillas invertidas."
+      placeholder: |
+        Traceback (most recent call last):
+          File "/home/bot.py", line 1, in main
+            foo = bar()
+          ...
+        telegram.error.BadRequest: Traceback not found
+      render: Python
+
+  - type: textarea
+    id: related-code
+    attributes:
+      label: "Código relacionado"
+      description: "Si el problema está relacionado con el código, pégalo aquí. Se formateará automáticamente en código (python), por lo que no es necesario que uses comillas invertidas."
+      placeholder: |
+        logging.basicConfig(
+            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
+        )
+
+        logger = logging.getLogger(__name__)
+      render: Python
+
+  - type: markdown
+    attributes:
+      value: "### Configuración"
+
+  - type: input
+    id: operating-system
+    attributes:
+      label: Sistema operativo
+    validations: 
+      required: true
+
+  - type: textarea
+    id: versions
+    attributes:
+      label: Versión de Python, python-telegram-bot y del resto de dependencias
+      description: Pega la salida del comando `$ python -m telegram`. Esto se formateará automáticamente en código, por lo que no es necesario que uses comillas invertidas.
+      render: Shell
+    validations: 
+      required: true

.github/workflows/auto-prerelease.yml

@@ -0,0 +1,31 @@
+name: "pre-release"
+
+on:
+  push:
+    branches:
+      - "main"
+      - "master"
+      - "develop"
+
+permissions:
+  id-token: "write"
+  contents: "write"
+  packages: "write"
+  pull-requests: "read"
+
+jobs:
+  pre-release:
+    name: "Pre Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Build & test"
+        run: |
+          echo "done!"
+
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          automatic_release_tag: "latest"
+          prerelease: true
+          title: "Development Build"

.github/workflows/auto-release.yml

@@ -0,0 +1,46 @@
+name: "auto-release"
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  id-token: "write"
+  contents: "write"
+  packages: "write"
+  pull-requests: "read"
+
+jobs:
+  tagged-release:
+    name: "Tagged Release"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Build & test"
+        run: |
+          echo "done!"
+
+      - uses: "marvinpinto/action-automatic-releases@latest"
+        with:
+          repo_token: "${{ secrets.GITHUB_TOKEN }}"
+          prerelease: false
+
+  notify_on_telegram:
+    name: "Notify on Telegram"
+    runs-on: "ubuntu-latest"
+    needs: "tagged-release"
+    steps:
+      - name: "Send Telegram message"
+        uses: "appleboy/telegram-action@master"
+        with:
+          to: "${{ secrets.TELEGRAM_TO }}"
+          token: "${{ secrets.TELEGRAM_TOKEN }}"
+          format: "html"
+          disable_web_page_preview: true
+          message: |
+            "¡Actualizaciones en <strong>${{ github.event.repository.name }}</strong>!
+  
+            Se ha publicado una nueva versión: <code>${{ github.ref_name }}</code>"
+
+            Puedes ver los cambios en el <a href="https://github.com/${{ github.repository }}/releases/latest">changeLog</a> y consultar la <a href="https://ritsi.github.io/${{github.event.repository.name}}/">documentación</a>."

.github/workflows/deploy-docs.yml

@@ -0,0 +1,46 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: deploy-docs
+
+on:
+  # Runs on pushes targeting the default branch
+  #push:
+  #  branches: ["main"]
+
+  # Runs when the workflow auto-release.yml has completed
+  workflow_run:
+    workflows: ["auto-release"]
+    types:
+      - completed
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  # Single deploy job since we're just deploying
+  create-docs:
+    environment: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r mkdocs-requirements.txt
+      - name: Build docs
+        run: mkdocs build
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/telegram-notify-issues.yml

@@ -0,0 +1,80 @@
+name: Telegram Message on Issues
+on: 
+  issues:
+    types: 
+      - opened
+      - closed
+      - reopened
+
+jobs:
+  build:
+    name: Notify Issues
+    runs-on: ubuntu-latest
+    steps:
+      - name: send telegram message on issue opened
+        uses: appleboy/telegram-action@master
+        if: ${{ github.event.action == 'opened' }}
+        with:
+          to: ${{ secrets.TELEGRAM_TO_GROUP }}
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          format: markdown
+          message: |
+            *¡Actualizaciones desde GitHub!*
+
+            *${{ github.actor }}* ha creado una nueva issue:
+            
+            Issue: `${{ github.event.issue.title }}`
+            Repositorio: `${{ github.repository }}`
+            
+            Puedes ver los cambios [aquí](${{ github.event.issue.html_url }})
+
+      - name: send telegram message on issue closed
+        uses: appleboy/telegram-action@master
+        if: ${{ github.event.action == 'closed' }}
+        with:
+          to: ${{ secrets.TELEGRAM_TO_GROUP }}
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          format: markdown
+          message: |
+            *¡Actualizaciones desde GitHub!*
+
+            *${{ github.actor }}* ha cerrado una issue:
+            
+            Issue: `${{ github.event.issue.title }}`
+            Repositorio: `${{ github.repository }}`
+            
+            Puedes ver los cambios [aquí](${{ github.event.issue.html_url }})
+
+      - name: send telegram message on issue reopened
+        uses: appleboy/telegram-action@master
+        if: ${{ github.event.action == 'reopened' }}
+        with:
+          to: ${{ secrets.TELEGRAM_TO_GROUP }}
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          format: markdown
+          message: |
+            *¡Actualizaciones desde GitHub!*
+
+            *${{ github.actor }}* ha reabierto una issue:
+            
+            Issue: `${{ github.event.issue.title }}`
+            Repositorio: `${{ github.repository }}`
+            
+            Puedes ver los cambios [aquí](${{ github.event.issue.html_url }})
+      
+      - name: send telegram message when issue have new comments
+        uses: appleboy/telegram-action@master
+        if: ${{ github.event.action == 'commented' }}
+        with:
+          to: ${{ secrets.TELEGRAM_TO_GROUP }}
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          format: markdown
+          message: |
+            *¡Actualizaciones desde GitHub!*
+
+            *${{ github.actor }}* ha comentado en una issue:
+            
+            Issue: `${{ github.event.issue.title }}`
+            Repositorio: `${{ github.repository }}`
+            
+            Puedes ver los cambios [aquí](${{ github.event.issue.html_url }})