Skip to content

Add Devin Playbook Sync workflow#23

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1762342496-playbook-sync-workflow
Open

Add Devin Playbook Sync workflow#23
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1762342496-playbook-sync-workflow

Conversation

@devin-ai-integration

Copy link
Copy Markdown

Add Devin Playbook Sync workflow

Summary

Adds a GitHub Actions workflow that automatically syncs markdown files from a playbooks/ directory to Devin using the newly created Playbook Sync action. The workflow triggers automatically on pushes to main when .md files in the playbooks/ directory change, and can also be triggered manually via workflow_dispatch.

Key features:

  • Automatic sync on push to main (when playbooks/*.md files change)
  • Manual trigger with operation choice (sync or list)
  • Outputs playbook IDs and sync count for verification
  • Handles empty directory gracefully with warning message

Review & Testing Checklist for Human

⚠️ CRITICAL - This workflow has NOT been tested with real API calls yet.

  • Configure DEVIN_API_KEY secret - Navigate to Settings → Secrets and variables → Actions → New repository secret. Add your Devin API key from Devin Settings. Without this, the workflow will fail immediately.

  • Test end-to-end with a real playbook - After configuring the secret:

    # Create playbooks directory and add a test file
    mkdir -p playbooks
    echo "# Test Playbook\n\nThis is a test playbook." > playbooks/test.md
    git add playbooks/test.md
    git commit -m "Add test playbook"
    git push origin main
    
    # Monitor workflow: Actions tab → "Sync Playbooks to Devin"
    # Verify playbook appears in Devin: https://app.devin.ai/settings
  • Test edge cases - Verify the action handles:

    • Markdown files with special characters (quotes, backticks, code blocks)
    • Large markdown files (>10KB)
    • Empty playbooks/ directory (should show warning, not fail)
    • Invalid API key (should fail with clear error)
  • Update action reference after merge - Currently uses @devin/1762305531-playbook-sync-action (PR branch). Change to @v1 after PR #2 in DEVIN-GITHUB-ACTIONS is merged and tagged.

  • Test manual workflow dispatch - Go to Actions → "Sync Playbooks to Devin" → Run workflow → Test both "sync" and "list" operations.

Notes

Limitations:

  • The playbooks/ directory doesn't exist yet in this repo. Create it before testing.
  • Any .md file pushed to playbooks/ on main will automatically sync. Consider using a separate branch for draft playbooks if needed.
  • The underlying action was tested only in dry-run mode. Real API behavior may differ slightly.

Action reference:

  • Currently references the PR branch because the action isn't released yet
  • All CI tests pass on that branch (3/3 checks passing)
  • Documentation: DEVIN-GITHUB-ACTIONS README

Session info:

- Automatically syncs markdown files from playbooks/ directory to Devin
- Triggers on push to main when .md files in playbooks/ change
- Supports manual workflow dispatch with sync and list operations
- Uses samfert-codeium/DEVIN-GITHUB-ACTIONS action
- Outputs playbook IDs and sync count for verification

Note: Requires DEVIN_API_KEY secret to be configured in repository settings
Co-Authored-By: Sam Fertig <sam.fertig@codeium.com>
@devin-ai-integration

Copy link
Copy Markdown
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

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.

0 participants