Release CI postprocesses docs and commits

Author: Bromeon

.github/other/apply-doc-cfg.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+# Copyright (c) godot-rust; Bromeon and contributors.
+# 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/.
+
+# Adds #[doc(cfg(...))] annotations to Rust docs, based on #[cfg(...)] in the source code.
+
+# Keep in sync with the same file in website repo.
+
+# Usage:
+#   apply-doc-cfg.sh [--install-sd] [--rustfmt]
+
+set -e
+
+
+for arg in "$@"; do
+  case "$arg" in
+    --install-sd)
+      installSd="true"
+      ;;
+    --rustfmt)
+      rustfmt="true"
+      ;;
+    *)
+      echo "Unknown argument: $arg"
+      exit 1
+      ;;
+  esac
+done
+
+SD_VERSION="1.0.0"
+PRE="DocCfg | "
+
+# For gdext, add feature/cfg annotations in docs. This needs nightly rustdoc + custom preprocessing.
+# Replace #[cfg(...)] with #[doc(cfg(...))], a nightly feature: https://doc.rust-lang.org/unstable-book/language-features/doc-cfg.html
+# Potential alternative: https://docs.rs/doc-cfg/latest/doc_cfg
+if [[ "$installSd" == "true" ]]; then
+  # Install sd (modern sed). No point in waiting for eternal `cargo install` if we can fetch a prebuilt binary in 1s.
+  echo "$PRE install sd (modern sed)..."
+  curl -L https://github.com/chmln/sd/releases/download/v${SD_VERSION}/sd-v${SD_VERSION}-x86_64-unknown-linux-musl.tar.gz -o archive.tar.gz
+  mkdir -p /tmp/tools
+  tar -zxvf archive.tar.gz -C /tmp/tools --strip-components=1
+  sd=/tmp/tools/sd
+else
+  sd=sd
+fi
+
+echo "$PRE preprocess docs..."
+
+# Enable feature in each lib.rs file.
+# Note: first command uses sed because it's easier, and only handful of files.
+find . -type f -name "lib.rs" -exec sed -i '1s/^/#![feature(doc_cfg)]\n/' {} +
+
+# Then do the actual replacements.
+# Could use \( -path "..." -o -path "..." \) to limit to certain paths.
+# Do NOT include './target/debug/build/*' because generated files cannot be modified -- rustdoc will rerun the generation.
+# This is done by directly emitting #[cfg_attr(published_docs, doc(cfg(...)))] in the godot-codegen crate, and that cfg is passed below.
+find . -type f -name '*.rs' \
+  \( -path './godot' -o -path './godot-*' \) \
+| while read -r file; do
+    # Replace #[cfg(...)] with #[doc(cfg(...))]. Do not insert a newline, in case the #[cfg] is commented-out.
+    # shellcheck disable=SC2016
+    $sd '(\#\[(cfg\(.+?\))\])\s*([A-Za-z]|#\[)' '$1 #[doc($2)]\n$3' "$file"
+    #                               ^^^^^^^^^^^^^^^^^ require that #[cfg] is followed by an identifier or a #[ attribute start.
+    # This avoids some usages of function-local #[cfg]s, although by far not all. Others generate warnings, which is fine.
+done
+
+if [[ "$rustfmt" == "true" ]]; then
+  echo "$PRE Format code using rustfmt..."
+  cargo fmt
+fi
+
+echo "$PRE Docs post-processed."

.github/workflows/release-version.yml

@@ -1,12 +1,17 @@
+# Copyright (c) godot-rust; Bromeon and contributors.
+# 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: "Release workflow"
 
 on:
   push:
-    branches:
-      - '!**'
-    tags:
-      # To include pre-releases: 'v0.1.[0-9]+-?*'
-      - 'v0.1.[0-9]+'
+#    branches:
+#      - '!**'
+#    tags:
+#      # To include pre-releases: 'v0.1.[0-9]+-?*'
+#      - 'v0.1.[0-9]+'
 
 env:
   # Note: used for test and clippy, not for publish
@@ -30,32 +35,37 @@ defaults:
 jobs:
   validation:
     runs-on: ubuntu-latest
+    outputs:
+      GDEXT_PUBLISHED_VERSION: ${{ steps.interpret-tag-version.outputs.GDEXT_PUBLISHED_VERSION }}
     steps:
       - uses: actions/checkout@v4
 
       # sed: https://unix.stackexchange.com/a/589584
       - name: "Interpret tag version"
+        id: interpret-tag-version
         run: |
-          version=$(echo "$GITHUB_REF" | sed -n "s#refs/tags/v\(.*\)#\1#p")
+          #version=$(echo "$GITHUB_REF" | sed -n "s#refs/tags/v\(.*\)#\1#p")
+          version="0.1.0" # DEBUG
           [ -z "$version" ] && {
             printf "\n::error::Failed to parse '$GITHUB_REF'.\n"
             exit 2
           }
           
           echo "Published version: $version"
-          echo "GDEXT_PUBLISHED_VERSION=$version" >> $GITHUB_ENV
+          echo "GDEXT_PUBLISHED_VERSION=$version" >> $GITHUB_OUTPUT
 
-      - name: "Verify that Cargo.toml versions match ${{ env.GDEXT_PUBLISHED_VERSION }}"
+      - name: "Verify that Cargo.toml versions match ${{ steps.interpret-tag-version.outputs.GDEXT_PUBLISHED_VERSION }}"
         run: |
           echo "Checking crate versions..."
+          publishedVersion="${{ steps.interpret-tag-version.outputs.GDEXT_PUBLISHED_VERSION }}"
           
           # Check if each Cargo.toml has that version
           IFS=' ' read -r -a publishedCrates <<< "$GDEXT_CRATES"
           for crate in "${publishedCrates[@]}"; do
             readVersion=$(grep -Po '^version = "\K[^"]*' "$crate/Cargo.toml")
             printf "* $crate -> $readVersion"
           
-            if [[ "$readVersion" != "$GDEXT_PUBLISHED_VERSION" ]]; then
+            if [[ "$readVersion" != "$publishedVersion" ]]; then
               printf "     ERROR\n"
               versionMismatch="1"
             else
@@ -128,17 +138,57 @@ jobs:
             exit 1
           }
 
-  publish:
+  docs-and-commit:
     runs-on: ubuntu-latest
-#    environment: 'Crates.io'
     needs:
+      - validation
       - unit-test
       - clippy
       - rustfmt
+    env:
+      GDEXT_PUBLISHED_VERSION: ${{ needs.validation.outputs.GDEXT_PUBLISHED_VERSION }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Install Rust (uncached)"
+        run: rustup update stable
+
+      - name: "Commit raw changes"
+        run: |
+          # Backup current repo, so we can checkout.
+          mkdir -p /tmp/repo
+          rsync -av --exclude .git --exclude target ./ /tmp/repo/ 
+          git switch releases || git switch --orphan releases
+          find . -mindepth 1 -maxdepth 1 ! -name '.git' -exec rm -rf {} +
+          # Restore.
+          rsync -av --ignore-existing /tmp/repo/ .
+          
+          # Commit.
+          git config user.name "Godot-Rust Automation"
+          git config user.email "GodotRust@users.noreply.github.com"
+          git add .
+          git commit -m "Repo state for v${{ env.GDEXT_PUBLISHED_VERSION }}."
+
+      - name: "Apply #[doc(cfg(...))]"
+        run: .github/other/apply-doc-cfg.sh --install-sd --rustfmt
+
+      - name: "Commit post-processed changes"
+        run: git commit -am "Postprocess docs for v${{ env.GDEXT_PUBLISHED_VERSION }}."
+
+      - name: "Push changes"
+        run: git push origin releases
+
+  publish:
+    runs-on: ubuntu-latest
+#    environment: 'Crates.io'
+    needs:
+      - docs-and-commit
     steps:
       # Note: we cannot dry-run the publishing, since crates depend on each other, and dry-run will fail if they aren't yet on crates.io.
       # Sleep to leave crates.io and docs.rs some time to index the dependencies, before releasing dependents.
       - uses: actions/checkout@v4
+        with:
+          ref: releases
 
       - name: "Install Rust (uncached)"
         run: rustup update stable