git-sdk

Git SDK contains adapter interfaces that a git connector can implement and use the sdk methods to publish events from the git tool (GitHub, GitLab, etc.) into DevRev.

Documentation

| Document | Description | |----------|-------------| | Git SDK integration for Git providers | Guide for integrating git-sdk with any Git provider (GitHub, GitLab, Bitbucket, Azure DevOps, etc.) | | GitHub Snap-in Integration — Example Implementation | Full example implementation using the GitHub snap-in as the reference |

In this repo you’ll also find:

• GIT_SDK_INTEGRATION_GUIDE.md — Technical integration guide (rules, API contracts, logs, checklist)
• GITHUB_INTEGRATION_EXAMPLE_IMPLEMENTATION.md — Example implementation walkthrough (GitHub snap-in)

Publishing a New Version

To publish a new version of @devrev/git-sdk to npm:

1. Bump the version in package.json on a new branch and merge to main.
2. Go to GitHub Actions → select the "Release package" workflow.
3. Click "Run workflow" on the main branch.
   • Check "Dry Run" to test without publishing.
   • Uncheck "Dry Run" to publish for real.

The workflow will:

• Create and push a git tag (v<version>)
• Create a GitHub Release with auto-generated release notes
• Run npm ci && npm run build && npm publish --access public

Note: Publishing is handled entirely through CI. There is no local publish script — the workflow uses repository secrets for npm authentication.