Update to Zig 0.15.1 and automate docs

Author: jkoop

.github/workflows/action.yml

@@ -0,0 +1,43 @@
+on:
+  push:
+  workflow_dispatch:
+
+permissions:
+  pages: write
+  id-token: write
+
+jobs:
+  autodocs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: mlugg/setup-zig@v1
+        with:
+          version: 0.15.1
+      - run: |
+          zig build-lib -femit-docs src/root.zig
+          mv docs _site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: mlugg/setup-zig@v1
+        with:
+          version: 0.15.1
+      - run: zig build test --summary all
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs:
+      - autodocs
+      - test
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,7 +1,7 @@
 # zigqlite
 
 > [!NOTE]  
-> Forked from https://chiselapp.com/user/javier/repository/zigqlite
+> Forked from https://chiselapp.com/user/javier/repository/zigqlite, 2024-07-24
 
 An [SQLite](https://sqlite.org) binding for [Zig](https://ziglang.org).
 
@@ -12,16 +12,15 @@ zig fetch --save https://github.com/jkoop/zigqlite/archive/COMMIT.zip
 ```
 
 ```zig
-// build.zig before b.installArtifact(exe);
-
-const zigqlite = b.dependency("zigqlite", .{
-    .target = target,
-    .optimize = optimize,
-}).module("zigqlite");
+// add to your build.zig, in your Module's .imports
+.{
+    .name = "zigqlite",
+    .module = b.dependency("zigqlite", .{ .target = target }).module("zigqlite"),
+},
 
+// add before `b.installArtifact(exe);`
 exe.linkSystemLibrary("c");
 exe.linkSystemLibrary("sqlite3"); // apt install libsqlite3-dev
-exe.root_module.addImport("zigqlite", zigqlite);
 ```
 
 ## Usage

build.zig

@@ -2,23 +2,21 @@ const std = @import("std");
 
 pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
-    const optimize = b.standardOptimizeOption(.{});
 
-    _ = b.addModule("zigqlite", .{
-        .root_source_file = b.path("src/sqlite.zig"),
+    const mod = b.addModule("zigqlite", .{
+        .root_source_file = b.path("src/root.zig"),
         .target = target,
-        .optimize = optimize,
     });
 
-    const main_tests = b.addTest(.{
-        .root_source_file = b.path("src/sqlite.zig"),
-        .target = target,
-        .optimize = optimize,
+    const mod_tests = b.addTest(.{
+        .root_module = mod,
     });
-    main_tests.linkSystemLibrary("c");
-    main_tests.linkSystemLibrary("sqlite3");
 
-    const test_step = b.step("test", "Run library tests");
-    const run_main_tests = b.addRunArtifact(main_tests);
-    test_step.dependOn(&run_main_tests.step);
+    mod_tests.linkSystemLibrary("c");
+    mod_tests.linkSystemLibrary("sqlite3");
+
+    const run_mod_tests = b.addRunArtifact(mod_tests);
+
+    const test_step = b.step("test", "Run tests");
+    test_step.dependOn(&run_mod_tests.step);
 }

build.zig.zon

@@ -1,14 +1,14 @@
 .{
     .name = .zigqlite,
-    .version = "0.0.0",
+    .version = "1.0.0",
     .fingerprint = 0xd7a23cabfc7db13a, // Changing this has security and trust implications.
-    .minimum_zig_version = "0.14.1",
+    .minimum_zig_version = "0.15.1",
     .dependencies = .{},
 
     .paths = .{
+        "LICENSE",
         "build.zig",
         "build.zig.zon",
         "src",
-        "LICENSE",
     },
 }