From 6956766b1008a4b0a6a37c6cd66ddb64dd4dea83 Mon Sep 17 00:00:00 2001 From: Gustavo Gonzalez Date: Wed, 25 Feb 2026 14:45:19 -0400 Subject: [PATCH] chore(docs): sync docs-live branch on release tags --- .github/workflows/release.yml | 6 ++++++ AGENTS.md | 1 + CHANGELOG.md | 2 +- README.md | 2 ++ 4 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 76678ce..1d9fd3f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,6 +32,12 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: sync docs-live branch to release tag + run: | + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + git push origin "${GITHUB_SHA}:refs/heads/docs-live" --force + - name: upload install marker env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/AGENTS.md b/AGENTS.md index 12fcb9d..1e94be1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -87,6 +87,7 @@ README.md # user-facing usage + caveats - Metadata commands (`version`, `schema`, `providers list`) bypass cache initialization. - Amounts used for swaps/bridges are base units; keep both base and decimal forms consistent. - Release artifacts are built on `v*` tags via `.github/workflows/release.yml` and `.goreleaser.yml`. +- Mintlify production docs should use the `docs-live` branch; the release workflow force-syncs `docs-live` to each `v*` tag. - `scripts/install.sh` installs the latest tagged release artifact into a writable user-space `PATH` directory by default (fallback `~/.local/bin`) and never uses sudo unless explicitly requested. - Docs site local checks (from `docs/`): `npx --yes mint@4.2.378 validate`, `npx --yes mint@4.2.378 broken-links`, and `npx --yes mint@4.2.378 a11y`. diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e9a960..d807b46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,7 +19,7 @@ Format: - None yet. ### Docs -- None yet. +- Release pipeline now syncs `docs-live` to each `v*` tag so Mintlify production docs can track the latest release instead of unreleased `main`. ### Security - None yet. diff --git a/README.md b/README.md index 6f78aef..750a4fa 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,8 @@ npx --yes mint@4.2.378 broken-links npx --yes mint@4.2.378 a11y ``` +Production docs deployment should target `docs-live` in Mintlify Git settings. The release workflow syncs `docs-live` to each `v*` tag so live docs align with released binaries. + ## Install ### 1) Quick install (macOS/Linux)