New CI workflow: document 'master' version and publish

Author: Bromeon

.github/workflows/doc.yml

@@ -0,0 +1,108 @@
+name: Doc
+
+# To save env-var dynamically: https://github.com/actions/starter-workflows/issues/68#issuecomment-792338408
+# Persist env-var across steps: echo "var=value" >> $GITHUB_ENV
+
+# Note: search-index.js is changing every single time, even if source is not changing. This file is around 2 MB.
+# Since the doc repo is cloned prior to committing, this might cause increasingly long CI times.defaults:
+# If necessary, archive the 'gh-pages' branch from time to time, or overwrite it altogether -- doc history might not be that important.
+
+
+on:
+  push:
+    branches: [master]
+
+
+env:
+  GDNATIVE_LIB_RS_PREFIX: |-
+      //! _**Note:** This documentation refers to the [latest GitHub version](https://github.com/godot-rust/godot-rust) and is subject to change._<br>
+      //! _For stable releases, visit [docs.rs/gdnative](https://docs.rs/gdnative)._
+      //! <br><br>
+      //!
+  GDNATIVE_DOC_REPO: git@github.com:godot-rust/doc.git
+  GDNATIVE_DOC_BRANCH: gh-pages
+
+
+# In the very unlikely cases where two PRs are merged, and the first 'doc' job is still running when the 2nd 'full-ci' starts,
+# make sure the first one is awaited. Even though docs are eventually overwritten, this ensures continuitiy in the doc repo history.
+concurrency:
+  group: 'sync-doc'
+  cancel-in-progress: false
+
+
+jobs:
+  sync-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v2
+
+      - name: "Install Rust"
+        uses: ./.github/composite/rust
+        with:
+          rust: stable
+          components: rustfmt
+
+      - name: "Pre-process input"
+        run: |
+          mv ${GITHUB_WORKSPACE}/gdnative/src/lib.rs tmp_lib.rs
+          (echo "${GDNATIVE_LIB_RS_PREFIX}"; cat tmp_lib.rs) > ${GITHUB_WORKSPACE}/gdnative/src/lib.rs
+
+      - name: "Generate documentation"
+        uses: actions-rs/cargo@v1
+        with:
+          command: doc
+          args: -p gdnative --lib --no-deps --all-features
+
+      # For email address, see https://github.community/t/github-actions-bot-email-address/17204
+      # As search-index.js changes every time, even if source hasn't changed, this will not need 'git commit --allow-empty'
+      - name: "Prepare upload"
+        run: |
+          mkdir ~/.ssh
+          echo '${{ secrets.DOC_DEPLOY_SSH_KEY }}' > ~/.ssh/id_rsa
+          chmod 700 ~/.ssh/id_rsa
+          git config --global user.name "godot-rust/doc[bot]"
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+          mkdir doc && cd doc
+          git clone --single-branch --branch ${GDNATIVE_DOC_BRANCH} --no-checkout ${GDNATIVE_DOC_REPO} . \
+            || (git init -b ${GDNATIVE_DOC_BRANCH} && git remote add origin ${GDNATIVE_DOC_REPO})
+
+          mv ${GITHUB_WORKSPACE}/target/doc/* .
+          mv ${GITHUB_WORKSPACE}/.github/workflows/doc/* .
+
+          GDNATIVE_VERSION=$(grep -Po '^version = "\K[^"]*' ${GITHUB_WORKSPACE}/gdnative/Cargo.toml)
+          GDNATIVE_SHORT_SHA=$(git rev-parse --short "${GITHUB_SHA}")
+
+          find gdnative -name .html -o -type f -print0 | xargs -0 sed -i 's/'"${GDNATIVE_VERSION}"'/master/g'
+
+          git add --all
+          git commit -m "Sync doc from ${GDNATIVE_SHORT_SHA}
+
+          Revision in godot-rust: ${GITHUB_SHA}"
+
+      - name: "Upload"
+        working-directory: doc
+        run: git push origin ${GDNATIVE_DOC_BRANCH}
+
+      - name: "Cleanup"
+        run: shred -u ~/.ssh/id_rsa
+
+
+
+# Possible alternative: dispatching a remote workflow
+
+#      - name: 'Dispatch remote workflow'
+#        run: >
+#          curl
+#            -X POST
+#            -H "Accept: application/vnd.github.v3+json"
+#            https://api.github.com/repos/godot-rust/doc/actions/workflows/triggered-remotely/dispatches
+#            -d '{"ref":"master"}'
+
+#      - name: Repository Dispatch
+#        uses: peter-evans/repository-dispatch@v1
+#        with:
+#          repository: godot-rust/doc
+#          token: ${{ secrets.REPO_ACCESS_TOKEN }}
+#          event-type: my-event

.github/workflows/doc/index.html

@@ -0,0 +1,7 @@
+<html>
+  <head>
+    <!-- Note: cache control not reliable through meta. The below redirection may remain cached in browsers. -->
+    <!-- Alternatively, use JS. Also, consider https://github.com/rust-lang/cargo/issues/739 in the future. -->
+    <meta http-equiv="refresh" content="0; url=/doc/gdnative" />
+  </head>
+</html>