-
Notifications
You must be signed in to change notification settings - Fork 0
chore: sync wiki/ folder to GitHub Wiki via Actions workflow #6
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: Sync wiki | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - wiki/** | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| sync: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Checkout wiki repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: ${{ github.repository }}.wiki | ||
| token: ${{ github.token }} | ||
| path: wiki-repo | ||
|
|
||
| - name: Push wiki folder to GitHub Wiki | ||
| run: | | ||
| git -C wiki-repo config user.name "github-actions[bot]" | ||
| git -C wiki-repo config user.email "github-actions[bot]@users.noreply.github.com" | ||
|
|
||
| # Copy wiki files while preserving the cloned repository metadata | ||
| rsync -av --delete \ | ||
| --exclude=".git/" \ | ||
| --exclude="WIKI_SETUP.md" \ | ||
| wiki/ wiki-repo/ | ||
|
|
||
| cd wiki-repo | ||
|
|
||
| git add -A | ||
|
|
||
| if git diff --cached --quiet; then | ||
| echo "No wiki changes to commit." | ||
| exit 0 | ||
| fi | ||
|
|
||
| git commit -m "Sync wiki from main repo @ ${{ github.sha }}" | ||
| git push | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The workflow embeds
GITHUB_TOKENdirectly in the clone URL. Ifgit clonefails (e.g., wiki repo not initialized) the error output can include the full URL, potentially exposing the token in logs. Prefer usingactions/checkoutwithrepository: ${{ github.repository }}.wikiandtoken: ${{ github.token }}(or otherwise avoid putting credentials in the URL).