Documentation deployment

.github/workflows/devnet-release.yml

@@ -49,7 +49,8 @@ jobs:
     - name: Push artifact
       run: |
         cargo build --release
-        tar -czvf composable-picasso-${{ env.RELEASE_VERSION }}.tar.gz target/release/composable
+        cargo doc
+        tar -czvf composable-picasso-${{ env.RELEASE_VERSION }}.tar.gz target/release/composable target/doc
         gsutil mv *.tar.gz gs://composable-binaries/community-releases/picasso/
 
     - name: Load state

nix/devnet-gce.nix

@@ -4,10 +4,6 @@
   localtunnel,
 }:
 let
-  gcefy-version = version:
-    builtins.replaceStrings [ "." ] [ "-" ] version;
-  domain = "composable-${composable.spec}-${gcefy-version composable.version}";
-  domain-latest = "composable-${composable.spec}-latest";
   machine-name = "composable-devnet-${composable.spec}";
 in {
   resources.gceNetworks.composable-devnet = credentials // {
@@ -52,35 +48,20 @@ in {
         serviceConfig = {
           Type = "simple";
           User = "root";
-          ExecStart = "${devnet}/bin/run-${composable.spec}";
+          ExecStart = "${devnet.script}/bin/run-${composable.spec}";
           Restart = "always";
           RuntimeMaxSec = "86400"; # 1 day lease period for rococo, restart it
         };
       };
-      systemd.services.localtunnel-commit = {
-        wantedBy = [ "multi-user.target" ];
-        after = [ "network.target" ];
-        description = "Local Tunnel Server";
-        serviceConfig = {
-          Type = "simple";
-          User = "root";
-          Restart = "always";
-          ExecStart = "${localtunnel}/bin/lt --port 80 --subdomain ${domain}";
-        };
-      };
-      systemd.services.localtunnel-latest = {
-        wantedBy = [ "multi-user.target" ];
-        after = [ "network.target" ];
-        description = "Local Tunnel Server";
-        serviceConfig = {
-          Type = "simple";
-          User = "root";
-          Restart = "always";
-          ExecStart = "${localtunnel}/bin/lt --port 80 --subdomain ${domain-latest}";
-        };
+      security.acme = {
+        acceptTerms = true;
+        email = "hussein@composable.finance";
       };
       services.nginx =
-        let virtualConfig =
+        let
+          runtimeName = pkgs.lib.removeSuffix "-dev" composable.spec;
+          domain = "${runtimeName}.devnets.composablefinance.ninja";
+          virtualConfig =
               let
                 routify-nodes = prefix:
                   map (node: (node // {
@@ -94,7 +75,19 @@ in {
                   routified-composable-nodes ++ routified-polkadot-nodes;
               in
                 {
-                  locations = builtins.foldl' (x: y: x // y) {} (map (node: {
+                  enableACME = true;
+                  forceSSL = true;
+                  locations = builtins.foldl' (x: y: x // y) {
+                    "= /doc/" = {
+                      return = "301 https://${domain}/doc/composable/index.html";
+                    };
+                    "= /doc" = {
+                      return = "301 https://${domain}/doc/composable/index.html";
+                    };
+                    "/doc/" = {
+                      root = devnet.documentation;
+                    };
+                  } (map (node: {
                     "/${node.name}" = {
                       proxyPass = "http://127.0.0.1:${builtins.toString node.wsPort}";
                       proxyWebsockets = true;
@@ -107,9 +100,11 @@ in {
                 };
         in {
           enable = true;
+          enableReload = true;
+          recommendedOptimisation = true;
+          recommendedGzipSettings = true;
           serverNamesHashBucketSize = 128;
-          virtualHosts."${domain}.loca.lt" = virtualConfig;
-          virtualHosts."${domain-latest}.loca.lt" = virtualConfig;
+          virtualHosts."${domain}" = virtualConfig;
         };
     };
 }

nix/devnet.nix

@@ -55,6 +55,8 @@ let
       tar -xvf $src
       mkdir -p $out/bin
       mv release/composable $out/bin
+
+      mv doc $out
     '';
   };
 
@@ -104,9 +106,11 @@ let
           }
       );
     };
-in
-pkgs.writeScriptBin "run-${composable.spec}" ''
-  #!${pkgs.bash}/bin/bash -e
-  rm -rf ${tmp-directory}
-  ${polkalaunch}/bin/polkadot-launch ${devnet-polkalaunch-config}
-''
+in {
+  script =
+    pkgs.writeShellScriptBin "run-${composable.spec}" ''
+      rm -rf ${tmp-directory}
+      ${polkalaunch}/bin/polkadot-launch ${devnet-polkalaunch-config}
+    '';
+  documentation = "${composable-bin}/share";
+}

nix/flake.nix

@@ -14,7 +14,7 @@
         (if builtins.pathExists ./devnet.json
          then builtins.fromJSON (builtins.readFile ./devnet.json)
          else throw "Devnet `devnet.json` definition missing, please follow the README.md instructions.");
-      mk-composable = spec: { name, version, hash}: {
+      mk-composable = spec: { name, version, hash }: {
         inherit name;
         inherit version;
         inherit spec;
@@ -95,14 +95,14 @@
       (system:
         let pkgs = import nixpkgs { inherit system; };
         in rec {
-          packages.devnet-dali = pkgs.callPackage ./devnet.nix {
+          packages.devnet-dali = (pkgs.callPackage ./devnet.nix {
             inherit (latest-dali) composable;
             inherit (latest-dali) polkadot;
-          };
-          packages.devnet-picasso = pkgs.callPackage ./devnet.nix {
+          }).script;
+          packages.devnet-picasso = (pkgs.callPackage ./devnet.nix {
             inherit (latest-picasso) composable;
             inherit (latest-picasso) polkadot;
-          };
+          }).script;
           packages.localtunnel = pkgs.mkYarnPackage rec {
             name = "localtunnel";
             src = localtunnel-src;