Merge pull request #328 from tayloraswift/prep-19

prepare for 0.19 release

Author: tayloraswift

Guides/docs.docc/Quickstart.md

@@ -26,8 +26,8 @@ Pre-built binaries are available for a limited set of platforms.
 
 | Platform | Download |
 |----------|----------|
-| macOS    | [`macOS-ARM64/unidoc.gz`](https://static.swiftinit.org/unidoc/0.19.0/macOS-ARM64/unidoc.gz) |
-| Linux    | [`Linux-X64/unidoc.gz`](https://static.swiftinit.org/unidoc/0.19.0/Linux-X64/unidoc.gz) |
+| macOS    | [`macOS-ARM64/unidoc.tar.gz`](https://static.swiftinit.org/unidoc/0.19.0/macOS-ARM64/unidoc.tar.gz) |
+| Linux    | [`Linux-X64/unidoc.tar.gz`](https://static.swiftinit.org/unidoc/0.19.0/Linux-X64/unidoc.tar.gz) |
 
 
 You can download and install the binary in your home directory like this:
@@ -41,42 +41,26 @@ Unidoc is an ordinary SwiftPM executable product. You can build it for your macO
 
 @Code(file: unidoc-from-source.sh, title: unidoc-from-source.sh)
 
-Please note that the executable as built by SwiftPM is named `unidoc-tools`, which you should rename to `unidoc` when installing it.
-
 
 >   Important:
 >   The rest of this guide assumes you have installed Unidoc somewhere on your macOS host that is visible in your `PATH` and allows you to invoke it as `unidoc`.
 
 
 ## 3. Launching a `mongod` instance
 
-If you have not already done so, clone the Unidoc project and navigate to the root of the repository:
+Unidoc can configure a `mongod` instance for you through the `unidoc init` command. This tool takes a directory path as an argument, which it uses to persist the state of the database. In the example below, we will create the documentation database in a directory named `unidoc` in your home directory.
 
 ```bash
-git clone https://github.com/tayloraswift/swift-unidoc
-cd swift-unidoc
+unidoc init ~/unidoc
 ```
 
-Use Docker Compose to launch a `mongod` instance in a container. This container is named `unidoc-mongod-container`. It has persistent state which `mongod` stores in a directory called `.mongod` at the root of the repository.
-
-```bash
-docker compose -f Guides/docs.docc/local/docker-compose.yml up
-```
+Please note that this will start a Docker container that runs continuously in the background. Therefore, if you want to dismantle the database, you must stop the container before deleting the persistence directory, otherwise it may recreate some of the files you delete.
 
 @Image(source: "Docker Desktop.png", alt: "Docker Desktop") {
 >   You should see the `unidoc-mongod-container` running in the Docker Desktop GUI.
 }
 
 
-The container is home to a MongoDB [replica set](https://www.mongodb.com/docs/manual/reference/replica-configuration/) which you need to initialize.
-
-Open a new terminal and run the following command to initialize the replica set:
-
-```bash
-docker exec -t unidoc-mongod-container /bin/mongosh --file /unidoc-rs-init.js
-```
-
-
 ## 3. Running `unidoc preview`
 
 The `unidoc preview` tool is a simple web server that links and serves documentation for local Swift packages. Run it directly from your macOS host like this:

Guides/docs.docc/local/load-standard-library.sh

@@ -1 +1 @@
-swift run -c release unidoc-tools local swift
+swift run -c release unidoc local swift

Guides/docs.docc/local/load-swift-nio.sh

@@ -1 +1 @@
-swift run -c release unidoc-tools local swift-nio -I /swift
+swift run -c release unidoc local swift-nio -I /swift

Guides/docs.docc/local/start-server.sh

@@ -1,2 +1,2 @@
 swift --version
-swift run -c release unidoc-tools preview
+swift run -c release unidoc preview

Guides/docs.docc/local/unidoc-from-source.sh

@@ -1,5 +1,5 @@
 mkdir -p ~/unidoc/bin
 git clone https://github.com/tayloraswift/swift-unidoc
 cd swift-unidoc
-swift build -c release --product unidoc-tools
-mv .build/release/unidoc-tools ~/unidoc/bin/unidoc
+swift build -c release --product unidoc
+mv .build/release/unidoc ~/unidoc/bin/unidoc

Guides/docs.docc/local/unidoc-install.sh

@@ -2,8 +2,7 @@ UNIDOC_MIRROR=https://static.swiftinit.org/unidoc
 UNIDOC_VERSION=0.19.0
 UNIDOC_PLATFORM=macOS-ARM64
 
-mkdir -p ~/unidoc/bin
-curl -L $UNIDOC_MIRROR/$UNIDOC_VERSION/$UNIDOC_PLATFORM/unidoc.gz \
-    -o ~/unidoc/bin/unidoc.gz
-gzip -fdk ~/unidoc/bin/unidoc.gz
-chmod +x ~/unidoc/bin/unidoc
+curl -L $UNIDOC_MIRROR/$UNIDOC_VERSION/$UNIDOC_PLATFORM/unidoc.tar.gz \
+    -o unidoc.tar.gz
+tar -xf unidoc.tar.gz
+sudo mv unidoc /usr/local/bin/unidoc

Package.resolved

@@ -8,7 +8,7 @@ let package:Package = .init(
     platforms: [.macOS(.v14)],
     products: [
         .executable(name: "ssgc", targets: ["ssgc"]),
-        .executable(name: "unidoc-tools", targets: ["unidoc-tools"]),
+        .executable(name: "unidoc", targets: ["unidoc-tools"]),
         .executable(name: "unidoc-publish", targets: ["unidoc-publish"]),
 
         .library(name: "guides", targets: ["guides"]),
@@ -70,7 +70,6 @@ let package:Package = .init(
 
         .library(name: "UCF", targets: ["UCF"]),
 
-        .library(name: "Unidoc", targets: ["Unidoc"]),
         .library(name: "UnidocAPI", targets: ["UnidocAPI"]),
         .library(name: "UnidocAssets", targets: ["UnidocAssets"]),
         .library(name: "UnidocAssets_System", targets: ["UnidocAssets_System"]),

Package.swift

@@ -54,13 +54,16 @@ extension AWS.S3.Client
         as path:String) async throws
     {
         let release:FilePath.Directory = scratch / "release"
-        let executable:FilePath = release / name
-        let compressed:FilePath = release / "\(name).gz"
+        let archive:FilePath = release / "\(name).tar.gz"
 
         print("Compressing \(name)...")
 
-        try SystemProcess.init(command: "gzip", "-kf", "\(executable)")()
-        let file:[UInt8] = try compressed.read()
+        try SystemProcess.init(command: "tar",
+            "--use-compress-program='gzip -9'",
+            "-C", "\(release)",
+            "-cf", "\(archive)",
+            name)()
+        let file:[UInt8] = try archive.read()
 
         try await self.connect
         {
@@ -72,7 +75,7 @@ extension AWS.S3.Client
             //  These could be big files, even compressed, so we need to increase the timeout.
             try await $0.put(object: object,
                 using: .standard,
-                path: "\(path).gz",
+                path: "\(path).tar.gz",
                 with: key,
                 timeout: .seconds(1200))
         }

Sources/unidoc-publish/Main.swift

@@ -0,0 +1,108 @@
+import System
+
+extension Main.Init
+{
+    struct Installation
+    {
+        let docker_compose_yml:FilePath
+        let unidoc_rs_init_js:FilePath
+        let unidoc_rs_conf:FilePath
+
+        let container:String
+        let localhost:Bool
+    }
+}
+extension Main.Init.Installation
+{
+    func create() throws
+    {
+        for (file, content):(FilePath, String) in [
+            (
+                self.docker_compose_yml,
+                Self.docker_compose_yml(container: self.container)
+            ),
+            (
+                self.unidoc_rs_conf,
+                Self.unidoc_rs_conf
+            ),
+            (
+                self.unidoc_rs_init_js,
+                Self.unidoc_rs_init_js(host: self.localhost ? "localhost" : "unidoc-mongod")
+            )
+        ]
+        {
+            try file.open(.writeOnly, permissions: (.rw, .r, .r), options: [.create, .truncate])
+            {
+                _ = try $0.writeAll(content.utf8)
+            }
+        }
+    }
+}
+
+extension Main.Init.Installation
+{
+    private
+    static func docker_compose_yml(container:String) -> String
+    {
+        """
+        services:
+            unidoc-mongod:
+                image: mongo:latest
+                container_name: \(container)
+                hostname: unidoc-mongod
+                networks:
+                    - unidoc-test
+                ports:
+                    - 27017:27017
+                restart: always
+                volumes:
+                    # cannot put this in docker-entrypoint-initdb.d, it does not work
+                    - ./unidoc-rs-init.js:/unidoc-rs-init.js
+                    - ./unidoc-rs.conf:/etc/mongod.conf
+                    - ./mongod:/data/db
+                command: mongod --config /etc/mongod.conf
+
+
+        networks:
+            unidoc-test:
+                name: unidoc-test
+                enable_ipv6: true
+                ipam:
+                    config:
+                        - subnet: 2001:0DB8::/112
+
+        """
+    }
+
+    private
+    static let unidoc_rs_conf:String = """
+    replication:
+        replSetName: unidoc-rs
+    net:
+        port: 27017
+        bindIp: 0.0.0.0
+        bindIpAll: true
+
+    """
+
+    private
+    static func unidoc_rs_init_js(host:String) -> String
+    {
+        """
+        db = connect('mongodb://unidoc-mongod:27017/admin');
+        db.runCommand({'replSetInitiate': {
+            "_id": "unidoc-rs",
+            "version": 1,
+            "members": [
+                {
+                    "_id": 0,
+                    "host": "\(host):27017",
+                    "tags": {},
+                    "priority": 1
+                }
+            ]
+        }});
+
+        """
+    }
+}