📝 generate docs and add workflow

.github/workflows/check.yml

@@ -0,0 +1,49 @@
+name: Zig Test
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+ branches: [main]
+
+env:
+ ZIG_VERSION: 0.14.0-dev.909+f9f894200
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Cache Zig
+ uses: actions/cache@v3
+ with:
+ path: ~/zig
+ key: ${{ runner.os }}-zig-${{ env.ZIG_VERSION }}
+
+ - name: Install Zig
+ if: steps.cache.outputs.cache-hit != 'true'
+ run: |
+ wget https://ziglang.org/builds/zig-linux-x86_64-${{ env.ZIG_VERSION }}.tar.xz
+ tar -xf zig-linux-x86_64-${{ env.ZIG_VERSION }}.tar.xz
+ mv zig-linux-x86_64-${{ env.ZIG_VERSION }} ~/zig
+
+ - name: Add Zig to PATH
+ run: echo "${HOME}/zig" >> $GITHUB_PATH
+
+ - name: Cache Zig build artifacts
+ uses: actions/cache@v3
+ with:
+ path: |
+ zig-cache
+ ~/.cache/zig
+ key: ${{ runner.os }}-zig-build-${{ hashFiles('**/*.zig') }}
+ restore-keys: |
+ ${{ runner.os }}-zig-build-
+
+ - name: Build and Run
+ run: zig build run -- info
+
+ - name: Unit testing
+ run: zig build test --summary all

.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Generate and Deploy Docs
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+ branches: [main]
+
+env:
+ ZIG_VERSION: 0.14.0-dev.909+f9f894200
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Cache Zig
+ uses: actions/cache@v3
+ with:
+ path: ~/zig
+ key: ${{ runner.os }}-zig-${{ env.ZIG_VERSION }}
+
+ - name: Install Zig
+ if: steps.cache.outputs.cache-hit != 'true'
+ run: |
+ wget https://ziglang.org/builds/zig-linux-x86_64-${{ env.ZIG_VERSION }}.tar.xz
+ tar -xf zig-linux-x86_64-${{ env.ZIG_VERSION }}.tar.xz
+ mv zig-linux-x86_64-${{ env.ZIG_VERSION }} ~/zig
+
+ - name: Add Zig to PATH
+ run: echo "${HOME}/zig" >> $GITHUB_PATH
+
+ - name: Cache Zig build artifacts
+ uses: actions/cache@v3
+ with:
+ path: |
+ zig-cache
+ ~/.cache/zig
+ key: ${{ runner.os }}-zig-build-${{ hashFiles('**/*.zig') }}
+ restore-keys: |
+ ${{ runner.os }}-zig-build-
+
+ - name: Build Docs
+ run: zig build docs
+
+ - name: Deploy to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: zig-out/docs

README.md

@@ -1,2 +1,4 @@
 # bitcoin-zig
+
 Libraries and primitives for Bitcoin, written in Zig.
+

build.zig

@@ -51,4 +51,14 @@ pub fn build(b: *std.Build) void {
  // running the unit tests.
  const test_step = b.step("test", "Run unit tests");
  test_step.dependOn(&run_lib_unit_tests.step);
+
+ // Add documentation generation step
+ const install_docs = b.addInstallDirectory(.{
+ .source_dir = lib.getEmittedDocs(),
+ .install_dir = .prefix,
+ .install_subdir = "docs",
+ });
+
+ const docs_step = b.step("docs", "Generate documentation");
+ docs_step.dependOn(&install_docs.step);
 }