Merge pull request #117 from TeenBiscuits/repo-mejoras

Mejoras para el repositorio
TeenBiscuits · Apr 5, 2024 · 105f530 · 105f530
2 parents 5864da8 + 26586c0
commit 105f530
Show file tree

Hide file tree

Showing 10 changed files with 271 additions and 82 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,60 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+name: "🐛 Informe de error/bug"
+description: "Crea un informe para ayudarnos a mejorar"
+title: "🐛 <bug>"
+labels: ["bug", "good first issue"]
+assignees: 
+  - TeenBiscuits
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ¡Gracias por colaborar cazando esos bugs que tantos dolores de cabeza dan! 💞
+  - type: input
+    id: bug
+    attributes:
+      label: "El error/bug"
+      description: "Una descripción clara y concisa de cuál es el error"
+    validations:
+      required: true
+  - type: dropdown
+    id: ubi
+    attributes:
+      label: ¿Donde se encuentra el error/bug?
+      multiple: true
+      options:
+        - Web / Documentación
+        - Código
+        - GitHub (Actions...)
+        - Otro
+  - type: input
+    id: steps
+    attributes:
+      label: "Pasos a reproducir"
+      description: "¿Que hay que hacer para que el error/bug pase?"
+      placeholder: "1. Hago esto/aquello..."
+    validations:
+      required: false
+  - type: input
+    id: extra
+    attributes:
+      label: "Información extra"
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Salida/Logs relevantes"
+      description: Copie y pegue cualquier registro relevante. Esto se formateará automáticamente en código, por lo que no será necesario utilizar comillas invertidas.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: "Código de Conducta"
+      description: Al enviar este bug, acepta seguir nuestro [Código de Conducta](https://github.com/TeenBiscuits/Pro2324#coc-ov-file)
+      options:
+        - label: Acepto seguir el Código de conducta de este proyecto.
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+blank_issues_enabled: true
+contact_links:
+  - name: 💻 ¡Quiero añadir código!
+    url: https://github.com/TeenBiscuits/Pro2324/pulls
+    about: ¡Es genial oir eso! Para colaborar haznos una pull request.
+  - name: ✉️ Soporte
+    url: mailto:[email protected]
+    about: Para cualquiera cuestión o comunicación relacionada con este repositorio.
diff --git a/.github/ISSUE_TEMPLATE/informe-de-error-bug.yml b/.github/ISSUE_TEMPLATE/informe-de-error-bug.yml
diff --git a/.github/ISSUE_TEMPLATE/mejora.yml b/.github/ISSUE_TEMPLATE/mejora.yml
@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+name: "💡 Solicitud de función"
+description: "Sugiere una idea para este proyecto."
+title: '💡 <mejora>'
+labels: 'mejora'
+assignees: 'TeenBiscuits'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ¡Gracias por colaborar con tus ideas! 💞
+  - type: input
+    id: title
+    attributes:
+      label: "La idea 💡"
+      description: "Descripción breve de la idea que tienes para este proyecto"
+    validations:
+      required: true
+  - type: dropdown
+    id: ubi
+    attributes:
+      label: ¿Para donde es la mejora?
+      multiple: true
+      options:
+        - Web / Documentación
+        - Código
+        - GitHub (Actions...)
+        - Otro
+  - type: input
+    id: steps
+    attributes:
+      label: "Cuéntame más 🤓"
+      description: "Explica tu idea"
+      placeholder: "Explica en profundidad tu idea..."
+    validations:
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Código de Conducta
+      description: Al enviar este bug, acepta seguir nuestro [Código de Conducta](https://github.com/TeenBiscuits/Pro2324#coc-ov-file)
+      options:
+        - label: Acepto seguir el Código de conducta de este proyecto.
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/solicitud-de-funcion.yml b/.github/ISSUE_TEMPLATE/solicitud-de-funcion.yml
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -2,7 +2,7 @@
 
 - [ ] He leído la [Guía de Contribución](https://github.com/TeenBiscuits/Pro2324/blob/main/CONTRIBUTING.md)
 - [ ] El código/documentación que voy a añadir es de mi propia creación y/o tengo derecho explícito para añadirlo
-- [ ] Respeto el [Código de Conducta](https://github.com/TeenBiscuits/Pro2324/blob/main/CODE_OF_CONDUCT.md)
+- [ ] Respeto el [Código de Conducta](https://github.com/TeenBiscuits/Pro2324#coc-ov-file)
 - [ ] He descomentado el ``CMakeLists.txt``
 - [ ] He añadido/actualizado una copia de mi/s archivo/s a ``./docs/code``.
 

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -1,8 +1,8 @@
 # SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
 #
-# SPDX-License-Identifier: GPL-3.0-only
+# SPDX-License-Identifier: GPL-3.0-only AND MIT AND Apache-2.0
 
-name: 🚀 Despliegue en producción
+name: 🚀 Despliegue Documentación
 
 on:
   push:
@@ -30,18 +30,27 @@ jobs:
     name: 📦 Construir
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repositorio
+      - name: ⬇️ Checkout repositorio
+        # GitHub Actions
+        # MIT
+        # https://github.com/actions/checkout
         uses: actions/checkout@v4
 
-      - name: Construir documentación de Writerside usando Docker
+      - name: 🏗️ Construir con Writerside usando Docker
+        # JetBrains Open Source
+        # Apache-2.0
+        # https://github.com/JetBrains/writerside-github-action
         uses: JetBrains/writerside-github-action@v4
         with:
           instance: ${{ env.INSTANCE }}
           artifact: ${{ env.ARTIFACT }}
           docker-version: ${{ env.DOCKER_VERSION }}
 
-      - name: Subir artefacto con los resultados de la construcción
+      - name: ⬆️ Subir artefacto con los resultados de la construcción
         uses: actions/upload-artifact@v3
+        # GitHub Actions
+        # MIT
+        # https://github.com/actions/upload-artifact
         with:
           name: docs
           path: |
@@ -55,13 +64,19 @@ jobs:
     needs: construir
     runs-on: ubuntu-latest
     steps:
-      - name: Descargar artefactos
+      - name: ⬇️ Descargar artefactos
+        # GitHub Actions
+        # MIT
+        # https://github.com/actions/download-artifact
         uses: actions/download-artifact@v3
         with:
           name: docs
           path: artifacts
 
-      - name: Comprobar documentación
+      - name: 📊 Comprobar documentación
+        # JetBrains Open Source
+        # Apache-2.0
+        # https://github.com/JetBrains/writerside-checker-action
         uses: JetBrains/writerside-checker-action@v1
         with:
           instance: ${{ env.INSTANCE }}
@@ -74,41 +89,51 @@ jobs:
     needs: [construir, comprobar]
     runs-on: ubuntu-latest
     steps:
-      - name: Descargar artefacto
+      - name: ⬇️ Descargar artefacto
+        # GitHub Actions
+        # MIT
+        # https://github.com/actions/download-artifact
         uses: actions/download-artifact@v3
         with:
           name: docs
 
-      - name: Descomprimir artefacto
+      - name: 🗃️ Descomprimir artefacto
         run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
 
-      - name: Configurar IndexNow
+      - name: 🔎 Configurar IndexNow
         run: echo ${{ secrets.INDEXNOW_KEY }} > dir/${{ secrets.INDEXNOW_KEY }}.txt
 
-      - name: Configurar Pages
+      - name: 🔩 Configurar Pages
         uses: actions/configure-pages@v5
 
-      - name: Empaquetar y subir artefacto de Pages
+      - name: 📦 Empaquetar y subir artefacto de Pages
         uses: actions/upload-pages-artifact@v3
         with:
           path: dir
 
-      - name: Implementar en GitHub Pages
+      - name: 📖 Implementar en GitHub Pages
+        # GitHub Actions
+        # MIT
+        # https://github.com/actions/deploy-pages
         id: deployment
         uses: actions/deploy-pages@v4
 
   publicar-indexes:
     name: 🔎 Publicar Indexes
     needs: [construir, comprobar, publicar]
     runs-on: ubuntu-latest
+    # 
     container:
       image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2
     steps:
-      - name: Descargar artefacto
+      - name: ⬇️ Descargar artefacto
+        # GitHub Actions
+        # MIT
+        # https://github.com/actions/download-artifact
         uses: actions/download-artifact@v3
         with:
           name: docs
-      - name: Unzip artefacto
+      - name: 🗃️ Descomprimir artefacto
         run: |
           unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
           env algolia-key='${{env.ALGOLIA_KEY}}' java -jar /opt/builder/help-publication-agent.jar \
@@ -126,8 +151,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⬆️ Subir Sitemap
+        # Bojie Yang
+        # MIT
+        # https://github.com/bojieyang/indexnow-action
         uses: bojieyang/indexnow-action@v2
         with:
           sitemap-location: 'https://teenbiscuits.github.io/Pro2324/sitemap.xml' 
           key: ${{ secrets.INDEXNOW_KEY }}
-          # endpoint: www.bing.com # Es el default
+          # endpoint: www.bing.com # Es el default
+          failure-strategy: error