Improved GitHub integration with pull request annotations

Improved GitHub integration with pull request annotations Improved GitHub integration with pull request annotations Improved GitHub integration with pull request annotations Improved GitHub integration with pull request annotations
Codeac brings the code quality analysis closer to your Pull Requests directly on GitHub thanks to the GitHub App integration. You can also find us in the GitHub Marketplace for even easier and more secure installation process.

We're constantly working on all aspects of our users' experience improvements. Recently, we launched GitHub App for Codeac.io. Here are the main benefits of the GitHub App:

1. Secure and quick integration with GitHub

All apps on GitHub Marketplace must meet certain requirements which ensure a high-quality standard of quality and security within the apps.

According to GitHub, "GitHub Apps are first-class actors within GitHub." A GitHub App acts on its own behalf, taking actions via the API directly using its own identity. Thanks to GitHub App, we are able to keep high standards to offer reliable and secure connection to your repositories.

For integration, you just have to authorize our App:

GitHub App authorization GitHub App authorization
GitHub App authorization

2. Account management with granular permissions

Account management is easy, thanks to the granularity of GitHub permission model. You simply choose the organization you want to install Codeac App to.

GitHub App installation for specific organizations GitHub App installation for specific organizations
GitHub App installation for specific organizations

After you install our App to chosen organizations, you can enable access to all the repositories or only to selected ones. Also, in this step, we now ask only those permissions that we really need to run the analyses and nothing more, like we had to do with an old OAuth App.

GitHub App permission selection GitHub App permission selection
GitHub App permission selection

3. Codeac's analysis directly in GitHub UI as annotations in pull requests and commits

One of the permissions we ask for installing the Codeac GitHub App is write access for checks, commit statuses, and pull requests. These allow us to show you the results directly in GitHub UI.

Codeac report in commit detail Codeac report in commit detail
Codeac report in commit detail

As a best practice, many developers tend to read their PRs before sending them over for review. Annotations help them focus on the code change instead of switching to a different application to verify violations of the coding style or introducing other regressions of code quality.

4. What changes for our current users?

If you're already using Codeac via OAuth app, you will be asked to authorize the GitHub App during your next login. After this, you'll be able to see all the results as you're used to now.

However, if you would like to leverage the GitHub App with all the benefits (annotations, account management, etc.), you have to install it for your organizations or repositories as described above.

Conclusion

Switching from an old OAuth App to GitHub App that integrates directly with GitHub API is a great step forward as it grants you - our users - more secure way to use Codeac.io. We believe that bringing Codeac’s analysis closer to GitHub will increase the productivity as well as code quality of your projects.

If you have any questions, please feel free to reach us at support@codeac.io.

Ready to get started?

Use your favorite version control system to sign-up.

Sign up for free