Skip to content

Enforce docs wiki publication in build-docs workflow #2

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
MichaelWeissDEV merged 5 commits into from
Jun 5, 2026
Merged

Enforce docs wiki publication in build-docs workflow #2

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc3dcfe
Initial plan
Copilot Jun 5, 2026
198337c
fix: make docs workflow resilient when wiki is unavailable
Copilot Jun 5, 2026
d41d9b7
fix: prevent docs workflow failure when wiki is unavailable
Copilot Jun 5, 2026
7822d62
fix: enforce docs wiki sync with token fallback
Copilot Jun 5, 2026
37c9afa
fix: require wiki sync in docs workflow
Copilot Jun 5, 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
18 changes: 14 additions & 4 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ on:
jobs:
build-docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
Expand All @@ -30,10 +32,18 @@ jobs:
- name: Generate API Docs
run: npx typedoc --options typedoc.json

- name: Verify wiki repository availability
env:
GH_TOKEN: ${{ secrets.WIKI_ACTION_TOKEN || github.token }}
run: |
if ! git ls-remote "https://x-access-token:${GH_TOKEN}@github.com/${{ github.repository }}.wiki.git" HEAD >/dev/null 2>&1; then
echo "::error::GitHub wiki repository is unavailable. Enable the repository wiki and ensure token permissions allow wiki push."
exit 1
fi

- name: Sync Wiki
uses: Andrew-Chen-Wang/github-wiki-action@v4
with:
wiki_folder: docs/api
commit_message: "docs: update API documentation [skip ci]"
env:
WIKI_PUSH_TOKEN: ${{ secrets.WIKI_ACTION_TOKEN }}
token: ${{ secrets.WIKI_ACTION_TOKEN || github.token }}
path: docs/api
commit-message: "docs: update API documentation [skip ci]"
Loading