docs: migrate site to Zensical#77
Open
alejandroGM0 wants to merge 5 commits intohiero-ledger:mainfrom
Open
Conversation
Signed-off-by: Alejandro <26930485+alejandroGM0@users.noreply.github.com>
alejandroGM0
force-pushed
the
docs/zensical-migration
branch
from
1d83a6c to
25ccc1d
Compare
manishdait
requested changes
Apr 23, 2026
Install Zensical directly in the docs workflow and contributor docs instead of keeping a separate requirements file. Keep the version explicit while Zensical is still in 0.0.x to avoid unexpected breaking changes. Signed-off-by: Alejandro <26930485+alejandroGM0@users.noreply.github.com>
GITHUB_TOKEN from pull_request workflows cannot write to the base repo when the PR head is a fork, so gh-pages push fails with 403. Still run the docs build; deploy and comment only for same-repo PRs. Signed-off-by: Alejandro <26930485+alejandroGM0@users.noreply.github.com>
Split the Docs workflow in two. The Docs workflow now only builds the site and uploads a docs-preview artifact, which is safe for fork PRs. A new Docs Preview Deploy workflow runs on workflow_run, downloads the artifact, and publishes the preview to gh-pages/pr/<n>/ and comments the URL on the PR, so fork PRs get previews too. Signed-off-by: Alejandro <26930485+alejandroGM0@users.noreply.github.com>
Treat the PR number from the artifact as untrusted: strictly validate it as a positive integer, and pass it to actions/github-script via env instead of an inline expression so no attacker-controlled text can be expanded into the script body. Signed-off-by: Alejandro <26930485+alejandroGM0@users.noreply.github.com>
Contributor
Author
|
I also fixed an issue where fork PR doc previews failed with a 403 because the read‑only GITHUB_TOKEN couldn't deploy; I split the flow so the PR job only builds and uploads an artifact, and a separate workflow_run deploys to /pr// and comments, restoring fork previews. |
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
2 participants
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
gh-pagesPR preview flowCloses #70.
Test plan
zensical build --clean