Skip to content

Restore the stellar-cli docs check for Mintlify - #3105

Merged
ElliotFriend merged 7 commits into
mainfrom
ci/stellar-cli-reusable-check
Nov 11, 2026
Merged

ElliotFriend merged 7 commits into
mainfrom
ci/stellar-cli-reusable-check

Conversation

@ElliotFriend

@ElliotFriend ElliotFriend commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

What

  • Adds .github/workflows/cli-build.yml, a reusable workflow that replaces the build.yml the migration removed. Given a stellar-cli-ref, it syncs the CLI help docs and cookbook, runs mint validate, and reports mint broken-links without failing.
  • Updates scripts/stellar_cli.mjs for Mintlify: it no longer writes to the deleted src/ (the script crashed), it writes title frontmatter instead of sidebar_position, and it fetches only cookbook/ and FULL_HELP_DOCS.md at the requested commit.
  • Stops scripts/stellar_cli_plugins.mjs from writing sidebar_position, which Mintlify ignores.
  • Adds the temporary /stellar-cli-repo/ clone to .mintignore, so mint validate skips it.
  • Removes scripts/fix_cli_links.sh, which rewrote links to the Docusaurus style.

Why

stellar-cli's docs.yml still calls build.yml@main, so its "Docs validation" check has failed on every run since #2941. stellar/stellar-cli#2888 switches it to cli-build.yml.

Known limitations

  • stellar-cli release branches still call build.yml, so their check keeps failing.
  • The sync formats files before validating, so formatting problems in stellar-cli get fixed instead of reported, the same as before.

The sync ran locally against a tag, main, a SHA, a release branch, and PR merge refs, and mint validate passes afterward. stellar/stellar-cli#2888 currently runs this workflow from this branch. After this merges, point it back at @main.

🤖 Generated with Claude Code

Re-add build.yml as a workflow_call target so stellar-cli's docs.yml can
validate its help docs and cookbook again. Update stellar_cli.mjs for the
Mintlify tree (no src/helpers, title front matter, no duplicate H1),
exclude the temporary stellar-cli clone from mint, and drop the
Docusaurus link fixer.
Replace the full clone (and fetch of every PR merge ref) with a shallow,
blob-filtered fetch of the requested ref and a sparse checkout of
cookbook/ and FULL_HELP_DOCS.md. Resolve the latest release tag with
ls-remote, and keep accepting pr/<n>/merge refs.
@mintlify

mintlify Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
stellar-docs 🟢 Ready View Preview Nov 10, 2026, 11:32 PM

Comment thread .github/workflows/cli-build.yml Resolved
Comment thread .github/workflows/cli-build.yml Resolved
Called from another repo, actions/checkout defaults to the default
branch, so a caller testing a stellar-docs branch ran main's scripts.
Also fix the header comment left stale by the rename.
Comment thread .github/workflows/cli-build.yml Fixed
Comment thread .github/workflows/cli-build.yml Fixed
Comment thread .github/workflows/cli-build.yml Fixed
Comment thread .github/workflows/cli-build.yml Resolved
The workflow is only called from stellar-cli. A dispatch trigger lets it
run in the default branch's cache scope, which CodeQL flags as cache
poisoning.
It was only needed to test a stellar-docs branch from stellar-cli before
merge. Callers use cli-build.yml@main, where the default-branch checkout
already matches.
@ElliotFriend
ElliotFriend requested review from fnando, kaankacar and leighmcculloch and removed request for kaankacar November 11, 2026 16:15
…ator

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ElliotFriend
ElliotFriend merged commit 4825920 into main Nov 11, 2026
8 checks passed
@ElliotFriend
ElliotFriend deleted the ci/stellar-cli-reusable-check branch November 11, 2026 23:03
leighmcculloch pushed a commit to stellar/stellar-cli that referenced this pull request Nov 11, 2026
### What

- Converts `cookbook/*.mdx` from Docusaurus to Mintlify syntax:
admonitions become `<Note>`, `<Tip>`, `<Info>`, and `<Danger>` callouts,
Docusaurus-only frontmatter keys are removed, and relative `.mdx` links
become root-relative paths.
- Changes the bare `cookbooktest.ignore` and `cookbooktest.fail` fence
flags to `cookbooktest.ignore=""` and `cookbooktest.fail=""`. Mintlify
showed the bare flags as code block titles. The test harness only checks
that the keys are present, so tests behave the same.
- Points `docs.yml` at stellar-docs' new `cli-build.yml` workflow
(stellar/stellar-docs#3105).
- Regenerates `FULL_HELP_DOCS.md`, which was out of date on `main` and
failing the pre-commit hook.

### Why

developers.stellar.org moved to Mintlify, and stellar-docs copies
`cookbook/` onto the site as is. The migration also removed the
`build.yml` that `docs.yml` called, so "Docs validation" has failed on
every run since.

### Known limitations

- `release/**` branches still call the removed `build.yml`, so their
docs check keeps failing until this change reaches them.
- The cookbook integration tests weren't run locally, because they need
a local network.
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.

3 participants