Implement GitHub Actions agentic workflow for multi-repo documentation sync#345
Open
Implement GitHub Actions agentic workflow for multi-repo documentation sync#345
Conversation
Add complete agentic workflow system for real-time documentation synchronization from 12 FalkorDB repositories including core database, SDKs, client libraries, and tools. Uses GitHub Actions with intelligent mapping and transformation of documentation content. Features: - Real-time sync via repository_dispatch events - Daily scheduled fallback sync at 2 AM UTC - Manual trigger support for testing - Jekyll build validation before PR creation - Automatic spellcheck integration - Human review required for all PRs - Uses default GITHUB_TOKEN (no additional secrets needed) Components: - Main workflow: .github/workflows/sync-docs-agentic.yml - Sync agent: .github/scripts/sync_docs.py - Agent instructions: .github/agents/doc-sync-agent.md - Documentation: .github/SYNC_WORKFLOW.md - Integration template: .github/SYNC_INTEGRATION_TEMPLATE.md Co-authored-by: DvirDukhan <[email protected]>
- Add .github/requirements.txt for Python dependencies - Update workflow to use requirements.txt - Enhance .gitignore to exclude Python cache, venv, and IDE files - Remove accidentally committed __pycache__ directory Co-authored-by: DvirDukhan <[email protected]>
|
|
||
| - name: Run spellcheck | ||
| if: steps.check_changes.outputs.has_changes == 'true' | ||
| uses: rojopolis/[email protected] |
Check warning
Code scanning / CodeQL
Unpinned tag for a non-immutable Action in workflow Medium
|
|
||
| - name: Create Pull Request | ||
| if: steps.check_changes.outputs.has_changes == 'true' | ||
| uses: peter-evans/create-pull-request@v6 |
Check warning
Code scanning / CodeQL
Unpinned tag for a non-immutable Action in workflow Medium
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
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.
Implements real-time documentation synchronization from 12 FalkorDB repositories using GitHub Actions agentic workflow pattern with repository_dispatch triggers, intelligent content mapping, and automated PR creation.
Architecture
Workflow (
.github/workflows/sync-docs-agentic.yml)repository_dispatcheventsGITHUB_TOKEN- no additional secrets requiredSync Agent (
.github/scripts/sync_docs.py)REPO_MAPPINGSdictRepository Mappings
Activation
Source repositories need webhook trigger workflow:
Template provided in
.github/SYNC_INTEGRATION_TEMPLATE.mdDocumentation
.github/SYNC_WORKFLOW.md- Setup, testing, troubleshooting, FAQ.github/agents/doc-sync-agent.md- Agent decision logic and content processing rules.github/SYNC_INTEGRATION_TEMPLATE.md- Source repo integration templateREADME.mdwith workflow overview and status badgeSecurity
All PRs require human review. No auto-merge. Permissions scoped to
contents:write,pull-requests:write,issues:read.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/graphql/usr/bin/gh gh repo view FalkorDB/skills --json name,url /home/REDACTED/.nvm/install.sh /home/REDACTED/.nvm/nvm-exec /home/REDACTED/.nvm/nvm.sh /home/REDACTED/.nvm/package.json /home/REDACTED/.nvm/rename_test.sh /home/REDACTED/.nvm/test(http block)/usr/bin/gh gh repo view FalkorDB/spring-data-falkordb --json name,url /home/REDACTED/.nvm/install.sh /home/REDACTED/.nvm/nvm-exec /home/REDACTED/.nvm/nvm.sh /home/REDACTED/.nvm/package.json /home/REDACTED/.nvm/rename_test.sh /home/REDACTED/.nvm/test(http block)If you need me to access, download, or install something from one of these locations, you can either: