Skip to content

Implement GitHub Actions agentic workflow for multi-repo documentation sync#345

Open
Claude wants to merge 4 commits intomainfrom
claude/update-repo-with-pr
Open

Implement GitHub Actions agentic workflow for multi-repo documentation sync#345
Claude wants to merge 4 commits intomainfrom
claude/update-repo-with-pr

Conversation

@Claude
Copy link
Contributor

@Claude Claude AI commented Feb 12, 2026

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)

  • Real-time sync via repository_dispatch events
  • Daily scheduled fallback at 2 AM UTC
  • Manual dispatch for testing
  • Jekyll build + spellcheck validation gates
  • Uses default GITHUB_TOKEN - no additional secrets required

Sync Agent (.github/scripts/sync_docs.py)

  • Maps source repos to destination paths via REPO_MAPPINGS dict
  • Adds Jekyll front matter automatically
  • Detects content changes - only creates PR when needed
  • Source attribution footer on all synced content

Repository Mappings

"FalkorDB": commands/, algorithms/, design/
"GraphRAG-SDK": genai-tools/GraphRAG-SDK/
"QueryWeaver": genai-tools/QueryWeaver/
"falkordb-py": getting-started/client-libraries/python/
"falkordb-ts": getting-started/client-libraries/typescript/
"JFalkorDB": getting-started/client-libraries/java/
"NFalkorDB": getting-started/client-libraries/dotnet/
"flex": udfs/flex/
"falkordb-browser": browser/
"FalkorDB-MCPServer": agentic-memory/

Activation

Source repositories need webhook trigger workflow:

on:
  push:
    branches: [main]
    paths: ['README.md', 'docs/**']

jobs:
  notify:
    steps:
      - uses: peter-evans/repository-dispatch@v3
        with:
          repository: FalkorDB/docs
          event-type: docs-sync
          client-payload: |
            {"repository": "${{ github.event.repository.name }}",
             "ref": "${{ github.ref_name }}",
             "sha": "${{ github.sha }}"}

Template provided in .github/SYNC_INTEGRATION_TEMPLATE.md

Documentation

  • .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 template
  • Updated README.md with workflow overview and status badge

Security

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
    • Triggering command: /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)
    • Triggering command: /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:

@Claude Claude AI changed the title [WIP] Open PR to update repository based on merges Add GitHub Actions agentic workflow for multi-repo documentation sync Feb 12, 2026
@Claude Claude AI requested a review from DvirDukhan February 12, 2026 15:51
Claude AI and others added 2 commits February 12, 2026 16:10
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

Unpinned 3rd party Action 'Agentic Documentation Sync' step
Uses Step
uses 'rojopolis/spellcheck-github-actions' with ref '0.33.1', not a pinned commit hash

- 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

Unpinned 3rd party Action 'Agentic Documentation Sync' step
Uses Step
uses 'peter-evans/create-pull-request' with ref 'v6', not a pinned commit hash
@Claude Claude AI changed the title Add GitHub Actions agentic workflow for multi-repo documentation sync Implement GitHub Actions agentic workflow for multi-repo documentation sync Feb 12, 2026
@gkorland gkorland marked this pull request as ready for review February 15, 2026 20:10
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.

3 participants