automatically build api docs with github actions

Author: imakira

.github/workflows/docs.yml

@@ -0,0 +1,22 @@
+name: "Test"
+on: push
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    permissions:                # Job-level permissions configuration starts here
+      contents: write           # 'write' access to repository contents
+    steps:
+      - uses: actions/checkout@v5
+      - uses: cachix/install-nix-action@v31
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+      - run: nix run .#docs
+      - name: Commit files
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git commit -a -m "automatically generate api docs"
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          branch: docs

deps.edn

@@ -25,13 +25,13 @@
                  slipset/deps-deploy {:mvn/version "0.2.0"}}
           :ns-default build}
   :neil {:project {:name net.coruscation/js4clj}}
-  :codox {:extra-deps {codox/codox {:mvn/version "0.10.8"}}
-          :exec-fn codox.main/generate-docs
-          :exec-args {:name "net.coruscation.js4clj"
-                      :description "Use JavaScript in JVM with Clojure by GraalJS"
-                      :namespaces [net.coruscation.js4clj.require
-                                   net.coruscation.js4clj.core
-                                   net.coruscation.js4clj.utils
-                                   net.coruscation.js4clj.js
-                                   net.coruscation.js4clj.api.polyglot]
-                      :output-path "docs"}}}}
+  :docs {:extra-deps {codox/codox {:mvn/version "0.10.8"}}
+         :exec-fn codox.main/generate-docs
+         :exec-args {:name "net.coruscation.js4clj"
+                     :description "Use JavaScript in JVM with Clojure by GraalJS"
+                     :namespaces [net.coruscation.js4clj.require
+                                  net.coruscation.js4clj.core
+                                  net.coruscation.js4clj.utils
+                                  net.coruscation.js4clj.js
+                                  net.coruscation.js4clj.api.polyglot]
+                     :output-path "docs"}}}}

flake.lock

@@ -0,0 +1,28 @@
+{
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+
+  outputs = { self, nixpkgs }:
+    let
+      supportedSystems = [ "x86_64-linux" "x86_64-darwin" "aarch64-linux" "aarch64-darwin" ];
+      forAllSystems = nixpkgs.lib.genAttrs supportedSystems;
+      pkgs = forAllSystems (system: nixpkgs.legacyPackages.${system});
+    in
+    {
+      packages = forAllSystems (system:
+        with pkgs.${system}; {
+        docs = (writeShellScriptBin "docs"
+          ''${clojure}/bin/clj -X:docs
+            echo "js4clj.coruscation.net" > docs/CNAME'');
+      });
+
+      devShells = forAllSystems (system: let
+      in {
+        default = pkgs.${system}.mkShellNoCC {
+          packages = with pkgs.${system}; [
+            (mkPoetryEnv { projectDir = self; })
+            poetry
+          ];
+        };
+      });
+    };
+}