Skip to content

ci: deploy docs to GitHub Pages on push to main#29

Merged
nkanu17 merged 3 commits intomainfrom
ci/docs-github-pages-deploy
May 8, 2026
Merged

ci: deploy docs to GitHub Pages on push to main#29
nkanu17 merged 3 commits intomainfrom
ci/docs-github-pages-deploy

Conversation

@nkanu17
Copy link
Copy Markdown
Contributor

@nkanu17 nkanu17 commented May 8, 2026

Summary

Wires up automated docs publishing to GitHub Pages now that the source
tree is on MkDocs Material (#28). The build runs on every push to main
and uploads site/ as a Pages artifact; the deploy job ships it to
https://redis-developer.github.io/sql-redis/.

This is a follow-up to #28: the deploy workflow and matching URL updates
were intended to land in that PR but did not make it into the merge.

What changed

New: .github/workflows/docs.yml

  • Triggers on push to main and via workflow_dispatch (manual rerun
    from the Actions tab).
  • Uses the same uv + Python 3.11 toolchain as test.yml and lint.yml
    for consistency.
  • fetch-depth: 0 so mkdocs-git-revision-date-localized-plugin can
    walk full history when computing per-page modification dates.
  • Builds with --strict so broken links or missing references fail the
    workflow before deploy runs.
  • Deploys via actions/deploy-pages@v4 (modern Pages "GitHub Actions"
    source; no gh-pages branch).
  • concurrency: pages with cancel-in-progress: false so concurrent
    pushes do not interrupt an in-flight deploy.
  • Permissions scoped to the minimum: contents: read, pages: write,
    id-token: write.

Config updates

  • mkdocs.yml: site_url -> https://redis-developer.github.io/sql-redis/
    so canonical links and the auto-generated llms.txt point at the
    live host.
  • README.md: replace the "docs site not yet live" callout with a
    direct link to the GitHub Pages URL; update the llms.txt bullet to
    the live URL.
  • AGENTS.md: same URL update in the discoverable-artifacts table
    and the hub-context section.

Pages itself

Already enabled on the repo with build_type=workflow:

$ gh api repos/redis-developer/sql-redis/pages
{
  "html_url": "https://redis-developer.github.io/sql-redis/",
  "build_type": "workflow",
  "https_enforced": true
}

The first run of this workflow on main is the first publish.

Cost

$0. Public-repo Pages hosting, HTTPS, and Actions minutes are all free.

Verification

$ DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs build --strict
INFO    -  Documentation built in ~3s

After merge, watch the Actions tab for the Deploy docs to GitHub Pages
run; the deploy URL appears in the run summary and at
https://redis-developer.github.io/sql-redis/.

Wires up automated docs publishing now that the source tree is on
MkDocs Material. Build runs on every push to `main` and uploads the
`site/` directory as a Pages artifact; the deploy job ships it to
`https://redis-developer.github.io/sql-redis/`.

Workflow (`.github/workflows/docs.yml`):
- Uses the same uv + Python 3.11 toolchain as `test.yml` and `lint.yml`
  for consistency.
- `fetch-depth: 0` so `mkdocs-git-revision-date-localized-plugin` can
  walk full history when computing per-page modification dates.
- Builds with `--strict` so broken links or missing references fail the
  workflow before deploy runs.
- Deploys via `actions/deploy-pages@v4` (no `gh-pages` branch; uses the
  modern Pages "GitHub Actions" source).
- `concurrency: pages` with `cancel-in-progress: false` so concurrent
  pushes do not interrupt an in-flight deploy.

Config:
- `mkdocs.yml`: `site_url` -> `https://redis-developer.github.io/sql-redis/`
  so canonical links and the auto-generated `llms.txt` point at the
  live host.
- `README.md`: replace the "docs site not yet live" callout with a
  direct link to the GitHub Pages URL; update the `llms.txt` bullet to
  the live URL.
- `AGENTS.md`: same URL update in the discoverable-artifacts table and
  the hub-context section.

Pages itself was enabled on the repo with `build_type=workflow` so the
first run of this workflow on `main` is the first publish.
@nkanu17 nkanu17 added auto:minor Increment the minor version when merged auto:release Create a release when this PR is merged labels May 8, 2026
nkanu17 added 2 commits May 8, 2026 19:07
- Remove the orange shields.io "Status: Experimental" badge and the
  matching blockquote callout. The Experimental tier note still lives
  in the docs site for context; the README no longer leads with it.
- Replace the plain `# sql-redis` title with a centered hero block
  matching the redisvl README pattern: Redis logo (canonical SVG from
  `redis/redis-vl-python/docs/_static/`) + `<h1>sql-redis</h1>` +
  one-line tagline + a Documentation / GitHub / PyPI link bar.
- Surface the published docs URL prominently right after the hero so
  new readers land on the live site before scrolling.
- Move the local docs preview command (`make docs-serve`) into the
  existing Development section where the other `make` targets live.
@nkanu17 nkanu17 requested review from Copilot and rbs333 May 8, 2026 23:07
@nkanu17 nkanu17 merged commit 68ec9e7 into main May 8, 2026
9 of 10 checks passed
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds an automated GitHub Actions workflow to build and deploy the MkDocs site to GitHub Pages, and updates repository URLs to point to the now-live docs.

Changes:

  • Add a new GitHub Actions workflow to build MkDocs on pushes to main and deploy via Pages artifacts.
  • Update MkDocs site_url and documentation references (README/AGENTS) to the GitHub Pages URL.
  • Refresh README header content and add a make docs-serve hint in the development section.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
.github/workflows/docs.yml New CI workflow to build MkDocs and deploy the site/ output to GitHub Pages.
mkdocs.yml Points site_url at the GitHub Pages canonical URL.
README.md Updates docs/llms links to GitHub Pages and adjusts top-of-file presentation + dev docs hint.
AGENTS.md Updates llms/docs URLs and notes Pages deployment source.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md
Comment on lines +108 to +109
*Experimental* tier as "SQL for Redis". Published docs:
[`redis-developer.github.io/sql-redis/`](https://redis-developer.github.io/sql-redis/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto:minor Increment the minor version when merged auto:release Create a release when this PR is merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants