Partner Journey
This page gives you the full picture before you write any code: what you need in place to begin, how your integration moves from your laptop to production, and who to talk to at each step.
If you are evaluating whether to build an integration, read this first. If you are ready to build, jump straight to Installation.
The journey at a glance
Before you start
Two prerequisites must be met before you can submit an integration. Both are handled outside the SDK:
- You must be a member of the CI HUB Sales Club.
- You must hold a valid CI HUB Integration SDK license.
These are commercial prerequisites, not technical ones. You can install the SDK and explore it locally without them — but you will need both in place before your integration can be submitted and released.
Step 1 — Build locally
No special permissions are required to start development. Install the SDK, build your integration, and run it on your own machine.
Scaffold a project and start the dev server:
npm create @ci-hub/integration my-integration
cd my-integration
npm run devThe SDK serves your integration at http://localhost:8080. Point a CI HUB development environment at this URL to test it end to end.
See Installation for the full setup, and Building an Integration for the handler guides.
Step 2 — Submit
When your integration is ready, submit it with the CLI:
npx integration-cli submitYou receive a submission ID and a confirmation email. The CLI also lets you track your submission status and view results across all submitted versions.
See the CLI reference for the full command set.
Step 3 — Review
The CI HUB team reviews your submission. When the review is complete you receive a notification email — either approved, or rejected with optional feedback.
If your submission is rejected, address the feedback locally and submit again. The cycle repeats until it is approved.
Step 4 — Release to stage
Once approved, your integration is deployed to the CI HUB stage server, where you can test it in a hosted environment before it reaches end users.
Step 5 — Release to production
When you have confirmed the integration works as expected on stage, email integration@ci-hub.com to request the production release.
CI HUB deploys it to the production server, and you receive a notification email when it goes live.
Updates
The same process applies to every later update. Build the new version locally, submit it, get it reviewed, test on stage, and request the production release.