Skip to content

ci: publish rustdoc through the Pages artifact instead of a side-channel gh-pages push #2916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huitseeker merged 3 commits into from
Apr 3, 2026
+38 −79
Merged

ci: publish rustdoc through the Pages artifact instead of a side-channel gh-pages push #2916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
685d30c
ci: publish rustdoc through the Pages artifact instead of a side-chan…
huitseeker Mar 26, 2026
af581b9
Merge branch 'next' into fix/pages-rustdoc-source-conflict
huitseeker Apr 3, 2026
c80c00e
Merge branch 'next' into fix/pages-rustdoc-source-conflict
huitseeker Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 38 additions & 16 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,35 +28,57 @@ jobs:
docs:
name: Generate and deploy crate documentation
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4

- name: Cleanup large tools for build space
uses: ./.github/actions/cleanup-runner

- name: Configure GitHub Pages
uses: actions/configure-pages@v5

- name: Generate documentation
run: |
rustup update --no-self-update
rustup default stable
make doc

- name: Prepare publish tree
- name: Prepare GitHub Pages artifact
run: |
set -euo pipefail
mkdir -p .gh-pages-publish/docs
if git ls-remote --heads origin gh-pages | grep -q gh-pages; then
git fetch --depth=1 origin gh-pages
git worktree add --detach .gh-pages-worktree FETCH_HEAD
rsync -a --delete --exclude ".git" .gh-pages-worktree/ .gh-pages-publish/
git worktree remove .gh-pages-worktree --force
fi
rm -rf .gh-pages-publish/docs
mkdir -p .gh-pages-publish/docs
rsync -a --delete target/doc/ .gh-pages-publish/docs/
touch .gh-pages-publish/.nojekyll
mkdir -p _site/docs

- name: Deploy documentation
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # pin@v3
# Publish a single Pages artifact so the live site does not depend on
# whichever Pages source GitHub happens to be configured to read.
cat > _site/index.html << 'EOF'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Redirecting to docs.miden.xyz</title>
<link rel="canonical" href="https://docs.miden.xyz/miden-vm/">
<meta http-equiv="refresh" content="0; url=https://docs.miden.xyz/miden-vm/">
</head>
<body>
<h1>Miden VM Documentation Has Moved</h1>
<p>This site has moved to
<a href="https://docs.miden.xyz/miden-vm/">docs.miden.xyz/miden-vm</a>.
You will be redirected automatically.</p>
</body>
</html>
EOF

rsync -a --delete target/doc/ _site/docs/
touch _site/.nojekyll

- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./.gh-pages-publish
path: ./_site

- name: Deploy documentation
id: deployment
uses: actions/deploy-pages@v4
63 changes: 0 additions & 63 deletions .github/workflows/redirect-pages.yml
View file
Open in desktop

This file was deleted.

Loading