Skip to main content

Task Breakdown: Git Operations

Feature ID: git-operations Status: Done (Retrospective; ongoing as new providers ship) Last updated: 2026-05-01


Phase 1 — SDK contract

  • T1. IGitProviderPlugin interface in @ever-works/plugin/git-provider.
  • T2. Capability registration (git-provider).

Phase 2 — Facade

  • T3. GitFacadeService with all method groups (repo / local / PR / branch / URL).
  • T4. Error hierarchy: GitFacadeError, NoGitProviderError, GitProviderNotFoundError, NoGitCredentialsError.
  • T5. Credential resolution cascade (explicit token → OAuth → error).
  • T6. cloneOrPull with local cache.
  • T7. push with maxRetries.

Phase 3 — GitHub plugin

  • T8. packages/plugins/github/ scaffold with metadata.
  • T9. IGitProviderPlugin implementation using Octokit + isomorphic-git.
  • T10. OAuth flow integration.
  • T11. PR-related methods (list, files, comment, close).

Phase 4 — Wiring

  • T12. DataGeneratorService uses the facade.
  • T13. MarkdownGeneratorService uses the facade.
  • T14. WebsiteGeneratorService uses the facade.
  • T15. CommunityPrProcessorService uses the facade.
  • T16. WorksConfigService uses the facade.

Phase 5 — Tests

  • T17. Unit tests on the facade with a mock provider.
  • T18. Integration tests against a real GitHub repo in CI.
  • T19. Error-hierarchy fire paths.

Phase 6 — Docs

  • T20. User-facing doc docs/features/git-operations.md.
  • T21. GitHub plugin doc docs/plugin-system/github-plugin.md.
  • T22. Retrospective spec/plan/tasks.

Future work (open)

  • GitLab provider plugin.
  • Bitbucket provider plugin.

Definition of Done

  • All shipped tasks complete, tests pass, docs present, constitution gates verified.