rejig the actions workflow to actually commit generated content

.github/workflows/build-artifact.yaml

@@ -7,24 +7,7 @@ env:
   PYTHON_VERSION: "3.11"
 
 jobs:
-  get-vineflower-version:
-    outputs:
-        version: ${{ steps.version.outputs.version }}
-    runs-on: "ubuntu-latest"
-    steps:
-        - uses: "actions/checkout@v3"
-        - name: "write version to outputs"
-          id: "version"
-          run: |
-            echo "version=$(cat vineflower-version)" >> $GITHUB_OUTPUT
-  run-docgen:
-    needs: get-vineflower-version
-    uses: "./.github/workflows/run-docgen.yaml"
-    with:
-        gradle_arguments: "-PvineflowerVersion=${{ needs.get-vineflower-version.outputs.version }} generate --target-dir build/gen-out"
-        artifact_pattern: "docgen/build/gen-out/"
   build-docs:
-    needs: run-docgen
     runs-on: "ubuntu-latest"
     steps:
     - name: "setup / checkout"
@@ -39,16 +22,10 @@ jobs:
     - name: "setup / python / dependencies"
       run: "pipenv install"
     - uses: "ammaraskar/sphinx-problem-matcher@master"
-    - name: "build / fetch generated content"
-      uses: "actions/download-artifact@v3"
-      with:
-        name: "build-output"
-        path: source/generated
     - name: "build / docs"
       env:
         SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
-        ls -lhr source/generated
         pipenv run make dirhtml
     - name: "store output"
       uses: "actions/upload-artifact@v3"

.github/workflows/check-docgen.yaml

@@ -1,9 +1,12 @@
+# Check that docgen builds properly
 name: "Build & Check Docgen"
 
 on:
   push:
     branches: ["**"]
+    branches-ignore: ["main"]
     tags-ignore: ["**"]
+    paths: ["docgen/**", "vineflower-version"]
   pull_request:
 
 jobs:

.github/workflows/update-docgen.yaml

@@ -0,0 +1,47 @@
+on:
+    push:
+        branches:
+            - "main"
+        paths:
+            - "docgen/**"
+            - vineflower-version
+
+name: "Update Docgen"
+
+jobs:
+  get-vineflower-version:
+    outputs:
+        version: ${{ steps.version.outputs.version }}
+    runs-on: "ubuntu-latest"
+    steps:
+        - uses: "actions/checkout@v3"
+        - name: "write version to outputs"
+          id: "version"
+          run: |
+            echo "version=$(cat vineflower-version)" >> $GITHUB_OUTPUT
+  run-docgen:
+    needs: get-vineflower-version
+    uses: "./.github/workflows/run-docgen.yaml"
+    with:
+        gradle_arguments: "-PvineflowerVersion=${{ needs.get-vineflower-version.outputs.version }} generate --target-dir build/gen-out"
+        artifact_pattern: "docgen/build/gen-out/"
+  commit:
+    needs: run-docgen
+    runs-on: ubuntu-latest
+    permissions:
+        contents: write
+    steps:
+        - uses: "actions/checkout@v3"
+        - name: "extract generated artifact"
+          uses: "actions/download-artifact@v3"
+          with:
+            name: "build-output"
+            path: source/generated
+        - name: "commit and update generated content"
+          run: |
+            git add -f source/generated
+            git commit -m 'update generated content' || exit 0
+            git push origin
+
+
+

docgen/build.gradle

@@ -1,7 +1,7 @@
 plugins {
     id 'java-library'
-    id 'com.diffplug.spotless' version '6.20.0'
-    id 'net.kyori.indra.licenser.spotless' version '3.1.2'
+    id 'com.diffplug.spotless' version '6.22.0'
+    id 'net.kyori.indra.licenser.spotless' version '3.1.3'
 }
 
 def javaTarget = 17

docgen/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

docgen/gradlew

@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -144,15 +145,15 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -201,11 +202,11 @@ fi
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \