ci: deploy docs to GitHub Pages on push to main#29
Merged
Conversation
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.
- 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.
There was a problem hiding this comment.
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
mainand deploy via Pages artifacts. - Update MkDocs
site_urland documentation references (README/AGENTS) to the GitHub Pages URL. - Refresh README header content and add a
make docs-servehint 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 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/) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
mainand uploads
site/as a Pages artifact; the deploy job ships it tohttps://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.ymlmainand viaworkflow_dispatch(manual rerunfrom the Actions tab).
test.ymlandlint.ymlfor consistency.
fetch-depth: 0somkdocs-git-revision-date-localized-plugincanwalk full history when computing per-page modification dates.
--strictso broken links or missing references fail theworkflow before deploy runs.
actions/deploy-pages@v4(modern Pages "GitHub Actions"source; no
gh-pagesbranch).concurrency: pageswithcancel-in-progress: falseso concurrentpushes do not interrupt an in-flight deploy.
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.txtpoint at thelive host.
README.md: replace the "docs site not yet live" callout with adirect link to the GitHub Pages URL; update the
llms.txtbullet tothe live URL.
AGENTS.md: same URL update in the discoverable-artifacts tableand the hub-context section.
Pages itself
Already enabled on the repo with
build_type=workflow:The first run of this workflow on
mainis the first publish.Cost
$0. Public-repo Pages hosting, HTTPS, and Actions minutes are all free.
Verification
After merge, watch the Actions tab for the
Deploy docs to GitHub Pagesrun; the deploy URL appears in the run summary and at
https://redis-developer.github.io/sql-redis/.