Set up your first workspace

Before you begin#

• Use a Google account or an email address you can access.
• Use a GitHub account that owns or administers the organization installation.
• Identify a provider repository with a committed OpenAPI 3 document and at least one supported consumer repository.
• Confirm that the Impact Gate GitHub App can access those repositories.

Connect and index#

1. 1

   Sign in

   Open Sign in. Choose Continue with Google, or enter your email and choose Send sign-in link. New users are sent to workspace setup.

2. 2

   Authorize GitHub

   On Connect your workspace, choose Connect GitHub. Complete authorization using the GitHub account that administers the intended organization.

3. 3

   Install or select the App

   If no installation is available, choose Install GitHub App and grant access to the intended repositories. Return to setup, refresh installations, and choose Connect beside the correct organization.

4. 4

   Select both sides of the dependency

   Under Choose repositories, select the API provider and the consumers you want included. Choose Save selection and start indexing.

5. 5

   Check indexing results

   Open Repositories. Wait for queued or indexing jobs to finish, then open Coverage for each repository. Resolve missing contracts or other relevant coverage gaps before relying on a report.

The expected result is a connected workspace with selected repositories, detected services, and any supported OpenAPI endpoints in API usage. A consumer-only repository can provide caller evidence even when it has no provider contract of its own.

Review your first report#

1. 1

   Make a contract change on a branch

   In the selected provider repository, make a deliberate change to its committed OpenAPI document. Keep the implementation and published contract consistent. For a reversible walkthrough, use a draft PR on a dedicated branch.

2. 2

   Open the pull request

   Create the PR against the appropriate base branch. Draft PRs are analyzed too. Impact Gate receives the event and queues analysis for the PR's exact head and base commits.

3. 3

   Find the check and comment

   In GitHub, look for the Impact Gate check. If Publish findings as pull request comments is enabled, the PR also receives a report comment. Analysis continues in the background.

4. 4

   Inspect dashboard findings

   Open Engineering overview, find the PR under Open findings, and select an endpoint to read the explanation and source evidence. Coverage findings can appear even when no affected consumer was confirmed.

5. 5

   Complete the walkthrough

   Read the coverage notes, confirm the analyzed head matches your latest commit, and close an example draft PR when finished. Keep normal review and compatibility checks in your delivery process.

Next steps#