Skip to content

ci(docs): remove dead publish workflow; fix spectaql for local docs builds - #442

Merged
bobodread876 merged 5 commits into
mainfrom
chore/remove-dead-graphql-docs-workflow
Jul 12, 2026
Merged

ci(docs): remove dead publish workflow; fix spectaql for local docs builds#442
bobodread876 merged 5 commits into
mainfrom
chore/remove-dead-graphql-docs-workflow

Conversation

@islandbitcoin

@islandbitcoin islandbitcoin commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Fixes the perpetually-red "Generate GraphQL Docs" check on main — final shape after the full investigation.

What we learned (in order)

  1. The workflow failed on every retained run: it pushed generated docs to a docs branch that only exists on upstream GaloyMoney/galoy — never on this fork.
  2. First instinct was to repoint it at the docs site — but docs.flashapp.me deploys from lnflash/flash-api-docs, which has its own complete generation pipeline: daily cron fetches the schema from api.flashapp.me via live introspection → regenerates → commits → deploy.yml ships to DO via doctl.
  3. That pipeline had been silently off since ~Oct 2025 — GitHub's disabled_inactivity (60 quiet days). It was never broken, just unplugged.

What this PR does

  • Deletes the flash-side workflow — redundant: the docs pipeline consumes the schema via introspection, not git. (Branch history shows the repoint detour; net diff = delete + the fixes below.)
  • spectaql ^2.3.0^3.0.9 — 2.x is package-rotted (arrangeData is not a function on Node 20 and 24, verified in isolation), so yarn build-docs was broken locally too. 3.0.9 verified against the public SDL.
  • De-galoys the spectaql config + tutorial (Flash title/contact, api.flashapp.me + api.test.flashapp.me servers, upstream postman link dropped) so local builds produce Flash-branded output.

Done outside this PR (flash-api-docs, already live)

  • update-docs.yml re-enabled + dispatched: first schema refresh in 11 months committed (b7d1021)
  • deploy.yml dispatched to ship it (its push-trigger is defeated by the updater's own [skip ci] commits — known quirk, noted for follow-up)
  • Cleanup of the detour: stray commit in flash-docs reverted; temporary deploy key + secret removed

🤖 Generated with Claude Code

bobodread876 and others added 3 commits July 12, 2026 08:11
Fails on every push to main (red since at least Jun 26, all retained
runs) because it commits generated docs to a 'docs' branch that only
exists on upstream GaloyMoney/galoy — the fork never created it. Even
if it existed, GitHub Pages is not configured on this repo and the
spectaql config is still galoy-branded, so the output would serve
nothing.

'yarn build-docs' and the spectaql config remain for local use. If we
ever want published API docs, that is a small deliberate project:
orphan docs branch (or gh-pages), enable Pages, rebrand
spectaql-config-template.yml.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Instead of deleting the never-working workflow (it pushed to a 'docs'
branch that only exists on upstream GaloyMoney/galoy), give it a real
destination: generate the spectaql API reference from the checked-in
public SDL and publish it into lnflash/flash-docs static/api-reference/,
which DO App Platform serves at docs.flashapp.me/api-reference.

- Cross-repo push via write deploy key on flash-docs
  (FLASH_DOCS_DEPLOY_KEY secret, installed)
- Rebrand spectaql config: Flash title/contact, real servers
  (api.flashapp.me + api.test.flashapp.me)
- Rebrand TUTORIAL.md endpoints; drop upstream postman link
- Path-filter the trigger (schema/spectaql/workflow changes only)
  + workflow_dispatch; skip publish when output unchanged

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@islandbitcoin islandbitcoin changed the title chore(ci): remove dead GraphQL-docs publish workflow ci(docs): repoint GraphQL docs publish at docs.flashapp.me/api-reference Jul 12, 2026
bobodread876 and others added 2 commits July 12, 2026 08:45
spectaql 2.3.x fails with 'TypeError: arrangeData is not a function' on
Node 20 AND 24 (verified in isolation) — its loose internal deps have
drifted; the docs build was broken independently of the publish target.
3.0.9 renders the full rebranded config cleanly (verified against the
public SDL: 1.1MB single-file reference, servers + intro items intact).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…flash-api-docs

Investigation found docs.flashapp.me is deployed from lnflash/flash-api-docs,
which has its own complete pipeline: a daily cron (update-docs.yml) fetches
the schema from api.flashapp.me via introspection, regenerates, commits, and
deploy.yml ships to DO App Platform via doctl. It had been silently OFF since
~Oct 2025 (GitHub disabled_inactivity after 60 quiet days) — now re-enabled
and verified end-to-end. A flash-side publish workflow is therefore redundant;
the schema reaches the docs pipeline through live introspection, not git.

Kept from this branch: spectaql 2.x->3.0.9 (2.x is package-rotted — fails on
Node 20 and 24) and the Flash rebrand of the spectaql config + tutorial, so
'yarn build-docs' works locally again.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@islandbitcoin islandbitcoin changed the title ci(docs): repoint GraphQL docs publish at docs.flashapp.me/api-reference ci(docs): remove dead publish workflow; fix spectaql for local docs builds Jul 12, 2026
@bobodread876
bobodread876 merged commit 63f8acd into main Jul 12, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants