Preview build POC (step 1: local) #794
Conversation
| import {findUp, pathExists} from 'find-up' | ||
| import { promisify } from 'node:util' | ||
| import child_process from 'node:child_process' | ||
| import deepmerge from '@fastify/deepmerge' |
There was a problem hiding this comment.
I think this needs to be listed in the package.json file.
There was a problem hiding this comment.
thanks - I think I added it in the wrong directory, I'll tidy up...
| clean: true | ||
| asciidoc: | ||
| attributes: | ||
| kroki-server-url: null |
There was a problem hiding this comment.
Not sure what this does, to be honest, but doesn't it need a setting?
There was a problem hiding this comment.
null gets set to ~ in YAML, which I think is the same as being unset.
(At any rate, the builds I tried didn't hang while trying to speak to our firewalled server, so I think it's OK)
It figures out url, branch, start_path from the current directory, Happy to talk through it if you want to know the gory details 👍 |
Streamline the step for aliasing `preview` to your docsSite location (assuming docs team standard MacOS)
"remote" build intended to be used on Github runner, based on payload passed in via Github Actions
|
I just want you to know that this is exactly what the Gradle Antora plugin and Antora Maven plugin were designed to do, without having to mess with JavaScript. See https://docs.antora.org/gradle-plugin/latest/playbook-provider/ and https://docs.antora.org/maven-plugin/latest/playbook-provider/ The playbook file is managed centrally in any repository you want. It then sets up a playbook to build just the content branch. Even if you don't end up using Maven or Gradle, you might be able to draw ideas from the design of the playbook provider capability in the plugins. NOTE: We envision adding this capability to the |
|
Thanks @mojavelinux ! At the very least, it sense-checks the requirement 👍 |
Step 1: a command
previewto build locallypreviewsee e.g. https://github.com/couchbaselabs/docs-columnar/blob/preview-build/antora.yml#L12-L21
SCREENCAST: https://drive.google.com/file/d/1ec4WXk77TYtQcJFjJDWMydf2gyhXLs9p/view?usp=sharing
NB: you'll want to add something like
alias preview='node ~/couchbase/docs-site/scripts/preview/preview.js'to your .zshrc (correct the path for your case)Roadmap:
Step 2: build remotely when branch is pushed
Step 3: niceties for VSCode etc.?