Actualizada rama

.all-contributorsrc

@@ -10,7 +10,7 @@
   "contributors": [
     {
       "login": "TeenBiscuits",
-      "name": "Pablo Portas",
+      "name": "Pablo Portas López",
       "avatar_url": "https://avatars.githubusercontent.com/u/81629707?v=4",
       "profile": "https://github.com/TeenBiscuits",
       "contributions": [
@@ -54,6 +54,15 @@
       "contributions": [
         "content"
       ]
+    },
+    {
+      "login": "Sprinter05",
+      "name": "Sprinter",
+      "avatar_url": "https://avatars.githubusercontent.com/u/69991979?v=4",
+      "profile": "https://sprinter05.github.io/",
+      "contributions": [
+        "code"
+      ]
     }
   ]
 }

.github/FUNDING.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
 github: [TeenBiscuits]
 ko_fi: pablopl
 custom: [paypal.me/pabloportaslopez]

.github/ISSUE_TEMPLATE/informe-de-error-bug.yml

@@ -1,3 +1,7 @@
+# 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] <bug>"

.github/ISSUE_TEMPLATE/solicitud-de-funcion.yml

@@ -1,3 +1,7 @@
+# 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: '[SOLICITUD DE FUNCIÓN] <mejora>'

.github/dependabot.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
 version: 2
 updates:
   - package-ecosystem: "github-actions" # See documentation for possible values

.github/pull_request_template.md

@@ -8,4 +8,4 @@
 
 ## ¿Qué he añadido?
 
-- Lista de lo que he añadido
+- Lista de lo que he añadido

.github/workflows/deploy.yml

@@ -1,19 +1,28 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
 name: Construir documentación
 
 on:
   push:
+    paths: ["docs/**"]
     branches: ["main"]
 
 permissions:
   id-token: write
   pages: write
 
 env:
-  INSTANCE: docs/pro
-  ARTIFACT: webHelpPRO2-all.zip
-  # Writerside docker image version
-  DOCKER_VERSION: 233.14389
-  ALGOLIA_ARTIFACT: algolia-indexes-PRO.zip
+  INSTANCE: 'docs/pro'
+  ARTIFACT: 'webHelpPRO2-all.zip'
+  DOCKER_VERSION: '233.14389'
+  ALGOLIA_ARTIFACT: 'algolia-indexes-PRO.zip'
+  ALGOLIA_APP_NAME: '0K3UBN277V'
+  ALGOLIA_INDEX_NAME: 'pro2324'
+  ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
+  CONFIG_JSON_PRODUCT: 'PRO'
+  CONFIG_JSON_VERSION: '2023-2024'
 
 jobs:
   construir:
@@ -30,55 +39,17 @@ jobs:
           artifact: ${{ env.ARTIFACT }}
           docker-version: ${{ env.DOCKER_VERSION }}
 
-      - name: Subir artefacto
+      - name: Subir artefacto con los resultados de la construcción
         uses: actions/upload-artifact@v4
         with:
           name: docs
           path: |
             artifacts/${{ env.ARTIFACT }}
             artifacts/report.json
+            artifacts/${{ env.ALGOLIA_ARTIFACT }}
           retention-days: 7
 
-      - name: Subir algolia-indexes
-        uses: actions/upload-artifact@v3
-        with:
-          name: algolia-indexes
-          path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
-          retention-days: 7
-
-  publicar-indexes:
-    env:
-      ALGOLIA_APP_NAME: 0K3UBN277V
-      ALGOLIA_INDEX_NAME: pro2324
-      ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }}
-      ALGOLIA_ARTIFACT: algolia-indexes-PRO.zip
-      CONFIG_JSON_PRODUCT: PRO
-      CONFIG_JSON_VERSION: 2023-2024
-    # Requires the build-job results
-    needs: construir
-    runs-on: ubuntu-latest
-    container:
-      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2
-
-    steps:
-      - name: Descargar artefacto
-        uses: actions/download-artifact@v3
-        with:
-          name: algolia-indexes
-      - name: Unzip 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 \
-          update-index \
-          --application-name ${{env.ALGOLIA_APP_NAME}} \
-          --index-name ${{env.ALGOLIA_INDEX_NAME}} \
-          --product ${{env.CONFIG_JSON_PRODUCT}} \
-          --version ${{env.CONFIG_JSON_VERSION}} \
-          --index-directory algolia-indexes/ \
-          2>&1 | tee algolia-update-index-log.txt
-
   comprobar:
-    # Requires build job results
     needs: construir
     runs-on: ubuntu-latest
 
@@ -98,8 +69,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    # Requires the build job results
-    needs: comprobar
+    needs: [construir, comprobar]
     runs-on: ubuntu-latest
     steps:
       - name: Descargar artefacto
@@ -113,11 +83,33 @@ jobs:
       - name: Configurar Pages
         uses: actions/configure-pages@v4
 
-      - name: Subir artefacto
+      - name: Empaquetar y subir artefacto de Pages
         uses: actions/upload-pages-artifact@v3
         with:
           path: dir
 
       - name: Implementar en GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
+
+  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
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+      - name: Unzip 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 \
+          update-index \
+          --application-name '${{env.ALGOLIA_APP_NAME}}' \
+          --index-name '${{env.ALGOLIA_INDEX_NAME}}' \
+          --product '${{env.CONFIG_JSON_PRODUCT}}' \
+          --version '${{env.CONFIG_JSON_VERSION}}' \
+          --index-directory algolia-indexes/ \
+          2>&1 | tee algolia-update-index-log.txt

.github/workflows/tests.yml

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+name: Comprobar documentación
+
+on:
+  pull_request:
+    types: ["opened"]
+    paths: ["docs/**"]
+
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: 'docs/pro'
+  ARTIFACT: 'webHelpPRO2-all.zip'
+  DOCKER_VERSION: '233.14389'
+  ALGOLIA_ARTIFACT: 'algolia-indexes-PRO.zip'
+  ALGOLIA_APP_NAME: '0K3UBN277V'
+  ALGOLIA_INDEX_NAME: 'pro2324'
+  ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
+  CONFIG_JSON_PRODUCT: 'PRO'
+  CONFIG_JSON_VERSION: '2023-2024'
+
+jobs:
+  construir:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repositorio
+        uses: actions/checkout@v4
+
+      - name: Construir documentación de Writerside usando Docker
+        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
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+            artifacts/${{ env.ALGOLIA_ARTIFACT }}
+          retention-days: 2
+
+  comprobar:
+    needs: construir
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Descargar artefactos
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Comprobar documentación
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+

.gitignore

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Pablo Portas López
+# SPDX-FileCopyrightText: 2023 Pablo Portas López <[email protected]>
 #
 # SPDX-License-Identifier: CC0-1.0
 

.reuse/dep5

@@ -1,10 +1,45 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: Pro2324
-Upstream-Contact: Pablo Portas Lopez <[email protected]>
+Upstream-Contact: Pablo Portas Lopez <[email protected]>
 Source: https://github.com/TeenBiscuits/Pro2324
 
-# Sample paragraph, commented out:
-#
-# Files: src/*
-# Copyright: $YEAR $NAME <$CONTACT>
-# License: ...
+Files:  logo/*
+        docs/images/Logo.*
+        docs/images/GitHubSponsors.png
+        docs/topics/*
+Copyright: 2023 Pablo Portas Lopez <[email protected]>
+License: CC-BY-NC-4.0
+
+Files:  .github/*
+        .all-contributorsrc
+        CONTRIBUTING.md
+        README.md
+        SECURITY.md
+        .idea/*
+        docs/cfg/*
+        docs/keymap.xml
+        docs/pro.tree
+        docs/redirection-rules.xml
+        docs/writerside.cfg
+Copyright: 2024 Pablo Portas Lopez <[email protected]>
+License: GPL-3.0-only
+
+Files:  CODE_OF_CONDUCT.md
+Copyright: 2021 Ethical Source
+License: CC-BY-4.0
+
+Files:  docs/images/Tutoriales/Compilador/*
+Copyright: Abel Cedron Santaeufemia
+License: CC-BY-4.0
+
+Files:  docs/topics/03-Apuntes/Pro-1/*
+Copyright: 2024 Daniel Feito Pin
+License: CC-BY-NC-4.0
+
+Files:  docs/images/Apuntes/Bibliografia/C-Programming-Book.png
+Copyright: K. N. King
+License: CC0-1.0
+
+Files:  src/Ejemplos/TAD_Rational/*
+Copyright: Facultade de Informatica de A Coruna
+License: CC-BY-4.0

CMakeLists.txt

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Pablo Portas López
+# SPDX-FileCopyrightText: 2023 Pablo Portas López <[email protected]>
 #
 # SPDX-License-Identifier: CC0-1.0
 

CODE_OF_CONDUCT.md

@@ -59,7 +59,7 @@ no.
 ## Aplicación
 
 Instancias de comportamiento abusivo, acosador o inaceptable de otro modo podrán ser reportadas a los administradores de
-la comunidad responsables del cumplimiento a través de [email protected]. Todas las quejas
+la comunidad responsables del cumplimiento a través de [email protected]. Todas las quejas
 serán evaluadas e investigadas de una manera puntual y justa.
 
 Todos los administradores de la comunidad están obligados a respetar la privacidad y la seguridad de quienes reporten

CONTRIBUTING.md

@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2024 Pablo Portas López
+SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]>
 
 SPDX-License-Identifier: GPL-3.0-only
 -->