You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace the legacy GitLab Pages automation with GitHub Actions workflows that validate Zensical docs builds on pull requests and deploy the built site/ output to GitHub Pages from main.
Self-contained context: This private repo already lives on GitHub at NVIDIA/OpenShell-Research, default branch main. The docs site uses Zensical with source under docs/, config in zensical.toml, pinned docs dependency in requirements-docs.txt, and canonical build script scripts/build-docs.sh. The repository currently has .gitlab-ci.yml for GitLab Pages, no .github/workflows, and no configured GitHub Pages site yet. Actions are enabled with write workflow permissions; GitHub-owned actions and official Pages actions are allowed. Backward compatibility is not required.
In scope: add GitHub Actions workflow files for docs CI and main GitHub Pages deployment; use current official GitHub-owned actions for checkout, Python setup, Pages configuration, Pages artifact upload, and Pages deployment; remove the obsolete .gitlab-ci.yml file if the new workflows supersede it.
Non-goals: live Pages verification and repository documentation cleanup beyond workflow-adjacent comments belong to later issues.
Backward compatibility: do not worry about it unless explicitly specified; do not preserve legacy GitLab CI behavior or add shims by default.
Dependencies: none.
Sequencing: first implementation issue; later issues depend on the concrete workflow paths and deployment behavior added here.
Implementation Notes
Relevant files likely include .gitlab-ci.yml, .github/workflows/*.yml, scripts/build-docs.sh, requirements-docs.txt, and zensical.toml. Prefer the existing scripts/build-docs.sh command so local and CI builds share behavior. The deploy workflow should grant least permissions needed for Pages: contents: read, pages: write, and id-token: write, with appropriate concurrency. Pull request validation should build docs without deploying.
Acceptance Criteria
GitHub Actions validates the docs build for pull requests and main pushes.
GitHub Actions deploys docs to Pages only from main after a successful build.
The legacy .gitlab-ci.yml no longer remains as the active CI/deployment path.
Workflow YAML uses allowed official GitHub-owned actions.
Objective
Replace the legacy GitLab Pages automation with GitHub Actions workflows that validate Zensical docs builds on pull requests and deploy the built
site/output to GitHub Pages frommain.Context
NVIDIA/OpenShell-Research, default branchmain. The docs site uses Zensical with source underdocs/, config inzensical.toml, pinned docs dependency inrequirements-docs.txt, and canonical build scriptscripts/build-docs.sh. The repository currently has.gitlab-ci.ymlfor GitLab Pages, no.github/workflows, and no configured GitHub Pages site yet. Actions are enabled with write workflow permissions; GitHub-owned actions and official Pages actions are allowed. Backward compatibility is not required.Scope
mainGitHub Pages deployment; use current official GitHub-owned actions for checkout, Python setup, Pages configuration, Pages artifact upload, and Pages deployment; remove the obsolete.gitlab-ci.ymlfile if the new workflows supersede it.Implementation Notes
Relevant files likely include
.gitlab-ci.yml,.github/workflows/*.yml,scripts/build-docs.sh,requirements-docs.txt, andzensical.toml. Prefer the existingscripts/build-docs.shcommand so local and CI builds share behavior. The deploy workflow should grant least permissions needed for Pages:contents: read,pages: write, andid-token: write, with appropriate concurrency. Pull request validation should build docs without deploying.Acceptance Criteria
mainpushes.mainafter a successful build..gitlab-ci.ymlno longer remains as the active CI/deployment path.Required Validation
python3 scripts/render-dev-notes.pyexits 0.python3 -m py_compile scripts/render-dev-notes.pyexits 0.scripts/build-docs.shexits 0 and writes the generated site tosite/.maindeploy does.PR Expectations
Include exact validation commands and results. Call out any repository settings still required for GitHub Pages activation after merge.