Skip to content

fix: stop mike from writing symlinks into gh-pages, breaking Pages deploy - #18

Merged
KP2048 merged 1 commit into
1.21.xfrom
worktree-fix-docs-pages-symlinks
Aug 13, 2026
Merged

fix: stop mike from writing symlinks into gh-pages, breaking Pages deploy#18
KP2048 merged 1 commit into
1.21.xfrom
worktree-fix-docs-pages-symlinks

Conversation

@KP2048

@KP2048 KP2048 commented Aug 13, 2026

Copy link
Copy Markdown
Member

Summary

GitHub's own automatic Pages build-and-deploy (the pages-build-deployment workflow, triggered whenever gh-pages is pushed - separate from this repo's own docs.yaml) has been failing every run:

Error: Artifact could not be deployed. Please ensure the content does not
contain any hard links, symlinks and total size is less than 10GB.

docs.yaml runs ./gradlew publishDocs, which shells out to mike deploy --push --update-aliases <tag> latest. mike's default alias type is symlink - the latest alias is committed into gh-pages as a literal filesystem symlink, which actions/deploy-pages now rejects outright.

Fix

Added --alias-type redirect to the mike deploy invocation - mike's own built-in alternative that writes a small HTML redirect page instead of a symlink for the alias. Functionally identical for anyone visiting /latest/, just no symlink in the tree.

Verified against the installed mike CLI: mike deploy --help lists --alias-type {symlink,copy,redirect} (default symlink).

Note

The next successful docs workflow run will redeploy gh-pages with the alias rebuilt as a redirect page instead of a symlink, which should let GitHub's automatic Pages deployment succeed again. No repo settings changes needed.

🤖 Generated with Claude Code

…ploy

GitHub's own automatic Pages build-and-deploy (triggered whenever
gh-pages is pushed - a separate workflow from this repo's docs.yaml)
started rejecting every deploy with "Artifact could not be deployed...
content does not contain any hard links, symlinks". mike's default alias
type ("symlink") is exactly that: the "latest" alias is a literal
filesystem symlink committed into gh-pages, which actions/deploy-pages
now refuses outright.

--alias-type redirect switches it to mike's own supported alternative: a
small HTML redirect page instead of a symlink, functionally identical for
visitors. Verified against the installed mike CLI (mike deploy --help
lists alias-type as one of symlink/copy/redirect, default symlink).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 13, 2026 04:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@KP2048
KP2048 merged commit d831546 into 1.21.x Aug 13, 2026
5 of 6 checks passed
@KP2048
KP2048 deleted the worktree-fix-docs-pages-symlinks branch August 13, 2026 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants