Merge docs-truth pass: README/site/notices/CI rewritten for the open-source reality

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Author: beetlebugorg

.github/workflows/ci.yml

@@ -4,73 +4,69 @@ on:
   push:
   pull_request:
 
-# NOTE: libtile57 is now the sole engine, so the build is CGO and links the native
-# static lib from the sibling chartplotter-native repo (built with Zig). This
-# workflow checks that repo out beside chartplotter-go and builds the lib first.
-# If chartplotter-native is PRIVATE, set a repo/PAT secret with read access to it
-# and pass it as `token:` on that checkout (a job's default GITHUB_TOKEN cannot
-# read a different private repo). UNVALIDATED — needs a test push to confirm the
-# setup-zig action version + checkout paths.
+# libtile57 is the sole engine: the build is CGO and statically links the native
+# lib from the public beetlebugorg/tile57 repo, built with Zig 0.16. That repo is
+# checked out as a SIBLING directory named tile57 (go.mod's replace points at
+# ../tile57/bindings/go, and the binding's cgo LDFLAGS at its zig-out/lib), with
+# submodules so the IHO S-101 catalogues are fetched from the IHO's own repos.
+# NOTE: correct-by-construction but unvalidated until pushed to GitHub.
 jobs:
   build-test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout chartplotter-go
+      - name: Checkout chartplotter
         uses: actions/checkout@v7
         with:
-          path: chartplotter-go
-      # The go.mod replace points at ../tile57/bindings/go and the binding's cgo
-      # LDFLAGS at ../../zig-out/lib/libtile57.a, so the native repo must sit at
-      # <workspace>/tile57 (sibling of chartplotter-go).
-      - name: Checkout chartplotter-native (libtile57)
+          path: chartplotter
+      - name: Checkout tile57 (libtile57 engine)
         uses: actions/checkout@v7
         with:
-          repository: beetlebugorg/chartplotter-native
+          repository: beetlebugorg/tile57
           path: tile57
-          # token: ${{ secrets.NATIVE_REPO_TOKEN }}   # uncomment if private
+          submodules: recursive
       - uses: actions/setup-go@v6
         with:
           go-version: '1.26'
           cache: true
-          cache-dependency-path: chartplotter-go/go.sum
+          cache-dependency-path: chartplotter/go.sum
       - name: Install Zig
-        uses: mlugg/setup-zig@v1
+        uses: mlugg/setup-zig@v2
         with:
           version: 0.16.0
       - name: Build libtile57
         run: cd tile57 && zig build
       - name: Format check
-        run: cd chartplotter-go && test -z "$(gofmt -l .)" || (gofmt -l . && exit 1)
+        run: make -C chartplotter fmt-check
       - name: Vet
-        run: cd chartplotter-go && go vet ./...
+        run: make -C chartplotter vet
       - name: Test
-        run: cd chartplotter-go && go test ./...
+        run: make -C chartplotter test
       - name: Build
-        run: cd chartplotter-go && go build ./...
+        run: make -C chartplotter build
 
   govulncheck:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout chartplotter-go
+      - name: Checkout chartplotter
         uses: actions/checkout@v7
         with:
-          path: chartplotter-go
-      - name: Checkout chartplotter-native (libtile57)
+          path: chartplotter
+      - name: Checkout tile57 (libtile57 engine)
         uses: actions/checkout@v7
         with:
-          repository: beetlebugorg/chartplotter-native
+          repository: beetlebugorg/tile57
           path: tile57
-          # token: ${{ secrets.NATIVE_REPO_TOKEN }}   # uncomment if private
+          submodules: recursive
       - uses: actions/setup-go@v6
         with:
           go-version: '1.26'
           cache: true
-          cache-dependency-path: chartplotter-go/go.sum
+          cache-dependency-path: chartplotter/go.sum
       - name: Install Zig
-        uses: mlugg/setup-zig@v1
+        uses: mlugg/setup-zig@v2
         with:
           version: 0.16.0
       - name: Build libtile57
         run: cd tile57 && zig build
       - name: Vulnerability scan
-        run: cd chartplotter-go && go run golang.org/x/vuln/cmd/govulncheck@latest ./...
+        run: cd chartplotter && go run golang.org/x/vuln/cmd/govulncheck@latest ./...

.github/workflows/docs.yml

@@ -11,6 +11,7 @@ on:
       - "web/**"
       - "cmd/**"
       - "internal/**"
+      - "pkg/**"
       - "scripts/fetch-demo-cells.sh"
       - "Makefile"
       - "go.mod"
@@ -27,16 +28,38 @@ concurrency:
   group: pages
   cancel-in-progress: true
 
+# The demo + Chart 1 tiles are baked by the chartplotter binary, which links the
+# native libtile57 engine — so this build needs the same sibling tile57 checkout
+# (with submodules: they fetch the IHO S-101 catalogues from the IHO's own repos)
+# and Zig toolchain as ci.yml. The repo is checked out into a subdirectory so
+# tile57 can sit beside it, matching go.mod's ../tile57/bindings/go replace.
+# NOTE: correct-by-construction but unvalidated until pushed to GitHub.
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v7
+      - name: Checkout chartplotter
+        uses: actions/checkout@v7
+        with:
+          path: chartplotter
+      - name: Checkout tile57 (libtile57 engine)
+        uses: actions/checkout@v7
+        with:
+          repository: beetlebugorg/tile57
+          path: tile57
+          submodules: recursive
 
       - uses: actions/setup-go@v6
         with:
           go-version: "1.26"
           cache: true
+          cache-dependency-path: chartplotter/go.sum
+      - name: Install Zig
+        uses: mlugg/setup-zig@v2
+        with:
+          version: 0.16.0
+      - name: Build libtile57
+        run: cd tile57 && zig build
 
       # Cache the curated NOAA demo-cell downloads (one per band over Annapolis),
       # keyed on the cell list / fetch script so a change re-downloads. Lets the
@@ -45,57 +68,52 @@ jobs:
         uses: actions/cache@v4
         with:
           path: ${{ runner.temp }}/demo-cells
-          key: demo-cells-${{ hashFiles('scripts/fetch-demo-cells.sh', 'Makefile') }}
+          key: demo-cells-${{ hashFiles('chartplotter/scripts/fetch-demo-cells.sh', 'chartplotter/Makefile') }}
 
       # Cache the S-52 PresLib "ECDIS Chart 1" source cells (the IHO draft zip is
       # fetched once and extracted), keyed on the fetch script so a change re-pulls.
       - name: Cache PresLib Chart 1 cells
         uses: actions/cache@v4
         with:
           path: ${{ runner.temp }}/preslib-cells
-          key: preslib-cells-${{ hashFiles('scripts/fetch-preslib-cells.sh') }}
+          key: preslib-cells-${{ hashFiles('chartplotter/scripts/fetch-preslib-cells.sh') }}
 
       # Build the read-only widget demo bundle into docs/static/demo so Docusaurus
-      # copies it into the published site at /chartplotter/demo/. Needs the S-101
-      # catalogue (IHO material kept out of the repo): clone it and let `make build`
-      # (a dep of `make demo`) embed it. The bundle is pure static files — no backend.
+      # copies it into the published site at /chartplotter/demo/. The S-101
+      # catalogue is embedded in libtile57 (fetched via the tile57 submodules
+      # above), so no catalogue clone or --s101 override is needed. The bundle is
+      # pure static files — no backend.
       - name: Build live demo bundle (docs/static/demo)
         run: |
-          git clone --depth 1 https://github.com/iho-ohi/S-101_Portrayal-Catalogue.git "$RUNNER_TEMP/s101-pc"
-          git clone --depth 1 https://github.com/iho-ohi/S-101-Documentation-and-FC.git "$RUNNER_TEMP/s101-fc"
-          make demo \
-            S101_PC="$RUNNER_TEMP/s101-pc/PortrayalCatalog" \
-            S101_FC="$RUNNER_TEMP/s101-fc/S-101FC/FeatureCatalogue.xml" \
+          make -C chartplotter demo \
             DEMO_CACHE="$RUNNER_TEMP/demo-cells" \
             DEMO_OUT="docs/static/demo"
 
       # Bake the S-52 "ECDIS Chart 1" reference sheet to tiles into docs/static/chart1
       # (published at /chartplotter/chart1/). The symbol-compliance docs page embeds
-      # it live, reusing the demo bundle's frontend assets. Reuses the S-101 catalogue
-      # cloned above; the source cells come from the IHO PresLib draft (fetched once).
+      # it live, reusing the demo bundle's frontend assets; the source cells come
+      # from the IHO PresLib draft (fetched once).
       - name: Build live Chart 1 tiles (docs/static/chart1)
         run: |
-          make demo-chart1 \
-            S101_PC="$RUNNER_TEMP/s101-pc/PortrayalCatalog" \
-            S101_FC="$RUNNER_TEMP/s101-fc/S-101FC/FeatureCatalogue.xml" \
+          make -C chartplotter demo-chart1 \
             PRESLIB_CACHE="$RUNNER_TEMP/preslib-cells" \
             DEMO_CHART1_OUT="docs/static/chart1"
 
       - uses: actions/setup-node@v6
         with:
           node-version: "20"
           cache: npm
-          cache-dependency-path: docs/package-lock.json
+          cache-dependency-path: chartplotter/docs/package-lock.json
       - name: Install
-        working-directory: docs
+        working-directory: chartplotter/docs
         run: npm ci
       - name: Build
-        working-directory: docs
+        working-directory: chartplotter/docs
         run: npm run build
 
       - uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/build
+          path: chartplotter/docs/build
 
   deploy:
     needs: build

.github/workflows/release.yml

@@ -1,5 +1,15 @@
 name: Release
 
+# chartplotter is SOURCE-ONLY: no binaries are ever published. Built binaries
+# embed the IHO S-101 catalogues (fetched at build time via the tile57 repo's
+# submodules from the IHO's own repositories), and the IHO's redistribution
+# terms are unresolved — see THIRD-PARTY-NOTICES.md. So a tag produces only a
+# GitHub release with generated notes (GitHub attaches the source archives
+# automatically); users clone tile57 + chartplotter and build locally per the
+# README.
+#
+# NOTE: unvalidated until a v* tag is pushed.
+
 on:
   push:
     tags:
@@ -9,43 +19,18 @@ permissions:
   contents: write
 
 jobs:
-  goreleaser:
+  source-release:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-go@v6
-        with:
-          go-version: "1.26"
-          cache: true
-
-      # NOTE: this release workflow is STALE — it still cross-compiles CGO-free,
-      # which no longer builds (libtile57 is a CGO dep). It needs the same rework as
-      # .goreleaser.yaml: build libtile57 with Zig per target, single CGO build,
-      # darwin on a macOS runner. The S-101 catalogue now lives inside libtile57, so
-      # there is no more catalogue-sync step.
-
-      # quill signs + notarizes the macOS binaries from this Linux runner (no Mac
-      # needed). The GoReleaser build hook (scripts/quill-sign.sh) invokes it.
-      - name: Install quill
-        run: |
-          go install github.com/anchore/quill/cmd/quill@latest
-          echo "$(go env GOPATH)/bin" >> "$GITHUB_PATH"
-
-      - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v7
-        with:
-          distribution: goreleaser
-          version: "~> v2"
-          args: release --clean
+      - name: Create source-only release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # macOS signing/notarization (quill). Set these as repo secrets; if they
-          # are absent the hook skips signing and the release still builds.
-          QUILL_SIGN_P12: ${{ secrets.MACOS_SIGN_P12 }}
-          QUILL_SIGN_PASSWORD: ${{ secrets.MACOS_SIGN_PASSWORD }}
-          QUILL_NOTARY_KEY: ${{ secrets.MACOS_NOTARY_KEY }}
-          QUILL_NOTARY_KEY_ID: ${{ secrets.MACOS_NOTARY_KEY_ID }}
-          QUILL_NOTARY_ISSUER: ${{ secrets.MACOS_NOTARY_ISSUER }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "$GITHUB_REF_NAME" \
+            --verify-tag \
+            --generate-notes \
+            --notes "**Source-only release.** No binaries are published: built binaries embed the IHO S-101 catalogues, whose redistribution terms are unresolved (see THIRD-PARTY-NOTICES.md). Build from source per the README: clone [tile57](https://github.com/beetlebugorg/tile57) as a sibling, init its submodules, then \`make build\` (Go 1.26+, Zig 0.16)."