Running Akita on every pull request allows you to detect breaking changes as soon as they get introduced. Akita will monitor your API tests, assess the impact of the change, and post the analysis on the responsible pull request. This allows you to get notifications in line with their other comments and requests.
Akita works in concert with GitHub and your CI/CD Pipeline to provide detailed API Analysis on every pull request. When you open a new pull request, GitHub will start a test run in your CI/CD Pipeline. Your CI/CD Pipeline will then start the Akita Client and run your API tests. The Akita Client will observe these tests and send observations to the Akita Cloud for analysis. When the Akita Cloud completes analyzing your API, it will post a comment on the pull request with the details.
Akita works together with GitHub and your CI/CD Pipeline to provide you with detailed API analysis on every pull request. For this to work, you will need to configure both GitHub and your test environment.
Before you can start getting an API analysis, you first need to trigger a test run on every pull request. This step will depend on what kind of CI/CD pipeline you have. We recommend you check the documentation for your CI/CD Pipeline for instructions on how to configure GitHub.
To observe your API tests, the Akita Client needs to be included in your CI/CD Pipeline. Adding the Akita Client to your CI/CD Pipeline will allow it to observe test traffic and build a model of your API. For more detailed instructions, see our Add Akita to a CI/CD Pipeline guide.
Now we'll show you how to use Akita to
GitHub & CI/CD Configuration
The remainder of this page describes how to connect Akita and GitHub.
To find all of the services that Akita supports, head over to the Integrations page in the Akita Console. You can find a link to Integrations in the left-hand menu, or you can go there directly using this URL: https://app.akita.software/integrations
To start installing the Akita on GitHub click the 'Integrate' button. You will then be redirected to GitHub to complete the installation process.
For the Akita GitHub application to work, you will need to grant it access to your pull requests. You can choose to give access to all or only selected repositories. Once you have made your selection click 'Install' to continue. After a moment, you will be redirected back to the Akita Console.
The GitHub integration has the ability to restrict the pull requests that receive comments from the integration. To enable this, create a team named "Akita Users" in your GitHub organization. Once this team is created, only pull requests from members of this team will receive comments. GitHub allows teams to include other teams, so you can add your existing teams to "Akita Users" for rapid configuration.
You have successfully connected Akita and GitHub. When you return to the Integrations page, you will see the list of repositories that Akita is monitoring.
Updated about a month ago
|Install in CI/CD|