Fix merge conflict on PR

.github/workflows/generate-docs.yaml → .github/workflows/merge-actions.yaml

@@ -1,12 +1,10 @@
-name: Generate the documentation from the JSON Schemas
-
 on:
   push:
     branches:
       - main
-      - docs
 jobs:
   generate_doc:
+    name: Generate the documentation from the JSON Schemas
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -16,6 +14,10 @@ jobs:
       contents: write
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
+        with:
+          repository: ${{ github.repository }}.wiki
+          path: .wiki
       - uses: actions/setup-python@v4
         with:
           python-version: "3.11"
@@ -28,27 +30,24 @@ jobs:
       - name: Install json-schema-for-humans
         run: pip install json-schema-for-humans
 
-      - name: Create documentation directory
-        run: mkdir -p _docs
-
       - name: Generate the documentation
         run: |
-          generate-schema-doc --config template_name=md_nested ./.schema/controller.json ./_docs/controller.md
-          generate-schema-doc --config template_name=md_nested ./.schema/manufacturer.json ./_docs/manufacturer.md
-          generate-schema-doc --config template_name=md_nested ./.schema/category.json ./_docs/category.md
+          generate-schema-doc --config template_name=md_nested ./.schema/controller.json "./.wiki/Controller Definition.md"
+          generate-schema-doc --config template_name=md_nested ./.schema/manufacturer.json "./.wiki/Manufacturer Definition.md"
+          generate-schema-doc --config template_name=md_nested ./.schema/category.json "./.wiki/Category Definition.md"
+
+      - name: Generate Conntroller List
+        run: |
+          python3 .utilities/generate_controller_tables.py
 
       - run: git pull
       - name: Commit files
         run: |
+          cd .wiki
           git config --local user.email "[email protected]"
           git config --local user.name "GitHub Action"
           git add *
           if ! git diff-index --quiet HEAD; then
             git commit -m "Update documentation" -a
           fi
-
-      - name: push changes
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ steps.extract_branch.outputs.branch }}
+          git push

.github/workflows/validate-json.yaml

@@ -2,19 +2,12 @@ on:
   pull_request:
     branches:
       - main
-name: Validate JSON
+
 jobs:
   validate:
+    name: Validate JSON Files against schemas
     runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
     steps:
-      - name: Delete previous comment
-        uses: izhangzhihao/delete-comment@master
-        with: 
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          delete_user_name: github-actions[bot]
-          issue_number: ${{ github.event.number }}
       - uses: actions/checkout@v3
       - name: Validate Category JSON
         uses: dsanders11/[email protected]
@@ -31,9 +24,16 @@ jobs:
         with:
           schema: ".schema/controller.json"
           files: "*/*/*/config.json"
-      - name: Comment PR
-        if: failure()
-        uses: thollander/[email protected]
-        with:
-          message: |
-            Validation of the JSON files has failed, please check the [Github Action log](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) to see why
+      - name: Send status
+        if: ${{ success() }}
+        run: |
+          curl --request POST \
+          --url https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }} \
+          --header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \
+          --header 'content-type: application/json' \
+          --data '{
+            "context": "Validate JSON Files against schemas",
+            "state": "success",
+            "description": "JSON Files are valid",
+            "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+          }'

.gitignore

@@ -1 +1,3 @@
-.schema/template.json
+.schema/template.json
+.schema/.json_schema.json
+.wiki

.schema/category.json

@@ -1,4 +1,5 @@
 {
+    "$id": "ControllerDatabase_category",
     "$schema": "http://json-schema.org/draft-06/schema#",
     "$ref": "#/definitions/CategoryDefinition",
     "definitions": {

.schema/controller.json

@@ -1,4 +1,5 @@
 {
+    "$id": "ControllerDatabase_controller",
     "$schema": "http://json-schema.org/draft-06/schema#",
     "$ref": "#/definitions/ControllerDefinition",
     "definitions": {
@@ -541,10 +542,14 @@
             "additionalProperties": false,
             "properties": {
                 "name": {
-                    "type": "string"
+                    "type": "string",
+                    "title": "Name"
                 },
                 "image": {
-                    "type": "string"
+                    "type": "string",
+                    "pattern": "(.*)\\.(p|P)(n|N)(g|G)",
+                    "title": "Image",
+                    "description": "Name of a PNG image showing the mentionned variant\nThe image must be placed in the same folder as this config file\nNote: At least one of the variants must use the default `image.png` file"
                 }
             },
             "required": [

.schema/manufacturer.json

@@ -1,4 +1,5 @@
 {
+    "$id": "ControllerDatabase_manufacturer",
     "$schema": "http://json-schema.org/draft-06/schema#",
     "$ref": "#/definitions/ManufacturerDefinition",
     "definitions": {

.utilities/consoles_list.json

@@ -0,0 +1,21 @@
+{
+    "dc": "Sega Dreamcast",
+    "n64": "Nintendo 64",
+    "nes": "Nintendo Entertainment System / Famicom",
+    "ngc": "Nintendo GameCube",
+    "nsw": "Nintendo Switch",
+    "ps1": "Sony PlayStation 1",
+    "ps2": "Sony PlayStation 2",
+    "ps3": "Sony PlayStation 3",
+    "ps4": "Sony PlayStation 4",
+    "ps5": "Sony PlayStation 5",
+    "saturn": "Sega Saturn",
+    "smd": "Sega Mega Drive / Sega Genesis",
+    "snes": "Super Nintendo Entertainment System / Super Famicom",
+    "wii": "Nintendo Wii",
+    "wiiu": "Nintendo Wii U",
+    "xb1": "Xbox One",
+    "xb360": "Xbox 360",
+    "xbox": "Xbox",
+    "xbs": "Xbox Series X|S"
+}