ci(data-deploy): build the index with relaton-cli instead of Jekyll - #58
Merged
Conversation
Replace the Jekyll-theme build (checkout jekyll-theme-relaton-data-index, merge _config.yml, jekyll build) with a single `relaton index` run: relaton-cli reads the repo's ./data and emits a self-contained, crawler-indexable index that inlines a compiled Vue+Tailwind bundle (relaton/relaton#83). Stays workflow_call with no required inputs, so existing callers are unchanged; optional title/data-dir/mode inputs allow per-repo overrides. Deploy job and default-branch gating are unchanged.
andrew2net
marked this pull request as ready for review
August 6, 2026 01:00
…lease gem (default): install the released relaton-cli (Ruby only; the gem ships the compiled frontend). git: check out relaton/relaton, compile the frontend (needs Node), and bundle relaton + relaton-cli from the checkout with pubid from git main — lets a repo pilot the new index build before relaton-cli is published.
This was referenced Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Replace the Jekyll-based
data-deploy.ymlbuild with a singlerelaton indexinvocation. relaton-cli reads the data repo's./datafolder and emits a self-contained, crawler-indexable index that inlines a compiled Vue+Tailwind bundle.Companion to relaton/relaton#83 (which added
relaton index).Two source modes (
sourceinput)gem(default) —gem install relaton-cliand run it. Ruby only; the released gem ships the precompiled frontend bundle. This is the steady-state path once relaton-cli is published.git— check outrelaton/relaton, compile the frontend on the fly (needs Node), and bundle relaton + relaton-cli from the checkout with pubid from gitmain(which relaton's code currently tracks). This lets a repo pilot the new index before any gem release.Why
gitmode needs Node: relaton-cli'sfrontend/dist/is gitignored (built at gem-release time), so a GitHub checkout must compile it (npm ci && npm run build). Thegempath avoids Node because the published gem already contains the bundle.Note:
relaton indexreads the data YAML directly and never invokes pubid, so the pubid pin only matters for loading relaton cleanly, not for the index output.Compatibility
on: workflow_callwith no required inputs — existing callers (uses: …/data-deploy.yml@main) are unchanged and getgemmode.source,title,data-dir,mode,relaton-cli-version(gem),relaton-repo/relaton-ref(git).v2fix) unchanged.Pilot a repo on GitHub today
Rollout / blockers
gemmode blocker:gem install relaton-climust resolve to a version that hasrelaton index. That release hasn't happened yet; the current line is a prerelease (3.0.0.pre.alpha.1), whichgem installskips by default — so pin it viarelaton-cli-version(or use--pre) until a stable release. Don't switch repos togemmode org-wide before then.relaton-data-bipmwithsource: git, verify, then move others._config.yml/Gemfile.deployare unused. Titles derive from the repo name (<FLAVOR> Index) unless the caller passestitle:.Verification
Locally,
relaton index --flavor bipmclonedrelaton-data-bipm, auto-detected thev2branch, and indexed 7,936 documents with correct raw-YAML links; the generatedindex.htmlcarries the crawler DOM + embedded JSON + inlined bundle. Workflow YAML lints clean.