Skip to content

README.md

Latest commit

 

History

History
49 lines (40 loc) · 2 KB

README.md

File metadata and controls

49 lines (40 loc) · 2 KB
Raw

team-ai-sync documentation

team-ai-sync keeps shared AI collaboration files, prompt files, editor settings, and repository guidance aligned across multiple repositories through pull requests or merge requests.

Use this documentation to install the GitHub Action, GitLab CI/CD Component, or Bitbucket Pipe; configure sync rules; create the right token; operate the workflow; and troubleshoot common failures.

Guides

  • Getting started: create a source repository, configure a workflow, and run your first sync.
  • Configuration reference: learn every sync-config.json field, default value, and behavior.
  • Authentication and permissions: choose a PAT or GitHub App token and grant the smallest useful permissions.
  • Operations guide: run dry runs, update existing pull requests, inspect outputs, and manage repository fleets.
  • Platform packages: use the GitHub Action, GitLab CI/CD Component, or Bitbucket Pipe.
  • Security model: understand path safety, token handling, pull request boundaries, and safe rollout practices.
  • Public demo walkthrough: follow the real public demo repositories, runs, and generated pull requests.
  • Troubleshooting: diagnose token, permission, config, branch, label, reviewer, and workflow issues.

Quick links

Current stable version

Use the stable v1 tag in workflows:

- uses: paladini/team-ai-sync@v1
  with:
    github-token: ${{ secrets.TEAM_SYNC_ADMIN_PAT }}
    config-path: sync-config.json