Merge #1047

1047: CI workflow to notify API Docs automation (gdnative) r=Bromeon a=Bromeon

Equivalent of godot-rust/gdext#259.

Co-authored-by: Jan Haller <bromeon@gmail.com>

Author: bors[bot]

.github/external-config/public-docs-token.txt

@@ -0,0 +1 @@
+MTFBQUZNN0NBMFNDMDRLWUQxNU5Oel9wazJ1Z3R4Q2U4alA4bFFIMHlzOU9raDNhZFZHTk44VUVlQ0F4Y3ZBeGIzV1BKSzNQN1FJOFlUdmQ4UQo=

.github/workflows/doc.yml

@@ -0,0 +1,105 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+name: Compile + Sync Docs
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - closed
+      - synchronize
+
+  push:
+    branches:
+      - master
+
+
+jobs:
+  notify-docs:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout is always needed, for the notify step
+      - name: "Checkout"
+        uses: actions/checkout@v3
+
+      # This is just a sanity check to make sure that the follow-up docs generation doesn't break.
+      # So we use the Rust version provided by the GitHub runners, which hopefully is >= MSRV.
+      - name: "Compile"
+        if: github.event_name == 'pull_request' && github.event.action != 'closed'
+        run: cargo check -p gdnative --features async,serde,inventory
+
+      # Pushed to master: no PR-related information
+      - name: "Construct JSON (for master)"
+        if: github.ref == 'refs/heads/master'
+        run: |
+          payload=$(cat <<'HEREDOC'
+          {
+            "op": "put",
+            "repo": "gdnative",
+            "num": "master",
+            "commit-sha": "${{ github.sha }}",
+            "date": "${{ github.event.head_commit.timestamp }}"
+          }
+          HEREDOC)
+          echo "VAR=$payload"
+          echo "GDNATIVE_JSON<<HEREDOC" >> $GITHUB_ENV
+          echo "${payload}" >> $GITHUB_ENV
+          echo "HEREDOC" >> $GITHUB_ENV
+
+      # Opened/reopened/updated PR: include PR author + title
+      - name: "Construct JSON (for PR sync)"
+        if: github.event_name == 'pull_request' && github.event.action != 'closed'
+        run: |
+          payload=$(cat <<'HEREDOC'
+          {
+            "op": "put",
+            "repo": "gdnative",
+            "num": "${{ github.event.number }}",
+            "commit-sha": "${{ github.event.pull_request.head.sha }}",
+            "date": "${{ github.event.pull_request.updated_at }}",
+            "pr-author": "${{ github.event.pull_request.user.login }}",
+            "pr-title": "${{ github.event.pull_request.title }}"
+          }
+          HEREDOC)
+          echo "VAR=$payload"
+          echo "GDNATIVE_JSON<<HEREDOC" >> $GITHUB_ENV
+          echo "${payload}" >> $GITHUB_ENV
+          echo "HEREDOC" >> $GITHUB_ENV
+
+      # Closed/merged PR: no more PR-related information necessary, as it will be removed
+      - name: "Construct JSON (for closed PR)"
+        if: github.event_name == 'pull_request' && github.event.action == 'closed'
+        run: |
+          payload=$(cat <<'HEREDOC'
+          {
+              "op": "delete",
+              "repo": "gdnative",
+              "num": "${{ github.event.number }}",
+              "date": "${{ github.event.pull_request.updated_at }}"
+          }
+          HEREDOC)
+          echo "VAR=$payload"
+          echo "GDNATIVE_JSON<<HEREDOC" >> $GITHUB_ENV
+          echo "${payload}" >> $GITHUB_ENV
+          echo "HEREDOC" >> $GITHUB_ENV
+
+      - name: "Print payload"
+        run: |
+          echo "$GDNATIVE_JSON"
+
+      - name: "Prepare request"
+        run: |
+          token=$(cat .github/external-config/public-docs-token.txt | base64 -w0 -d)
+          echo "DOCS_GENERATOR_TOKEN=github_pat_$token" >> $GITHUB_ENV
+
+      - name: "Notify doc workflow"
+        uses: peter-evans/repository-dispatch@v2
+        with:
+          token: ${{ env.DOCS_GENERATOR_TOKEN }}
+          repository: godot-rust/dispatch-forwarder
+          event-type: 'Generate docs'
+          client-payload: ${{ env.GDNATIVE_JSON }}
+

.github/workflows/doc/index.html

@@ -10,7 +10,7 @@
 
 **godot-rust** is a Rust library that implements native bindings for the [Godot game engine](http://godotengine.org/). This allows you to develop games or other applications in Godot, while benefiting from Rust's strengths, such as its type system, scalability and performance.
 
-> **Note**: if you are looking for a Rust binding for GDExtension (Godot 4), checkout [`gdextension`](https://github.com/godot-rust/gdextension).
+> **Note**: if you are looking for a Rust binding for GDExtension (Godot 4), checkout [`gdext`](https://github.com/godot-rust/gdext).
 
 
 ## Stability