Product
PR Review (Gitlab)

Archie AI PR Review Installation Guide (For Gitlab)

Overview

Archie AI provides an intelligent PR Review feature that integrates seamlessly with GitHub and GitLab repositories. This feature helps streamline the code review process by offering automated reviews, code suggestions, and interactive walkthroughs. Here in this article we explain how to setup your gitlab repository with ArchieAI to utilize the functionality.

Automatic Setup

Setting up Archie AI for your GitLab repositories is quick and easy. Follow these simple steps:

  1. Install Archie AI in your GitLab Repository:

    • Navigate to the PR Review section in your Archie AI Dashboard.
    • Click on the "Switch to GitLab" or "Connect with GitLab" button.
    • You'll be redirected to the GitLab OAuth application screen.
    • Grant Archie AI the necessary permissions to access your repositories.

  2. Configure Your Settings:

    • Select your desired repository from the dropdown menu.
    • Choose the appropriate settings: Recommend selecting "Review every PR on open" and "Auto-update the PR summary and title submitted by the author" at the top.
    • Click "Add new configuration" to save your preferences.

  3. Test Archie AI:

    • To see Archie AI in action, simply type "/help" in the comment section of any merge request.
    • Enjoy the power of AI-assisted code reviews!

With these steps completed, you're all set to leverage Archie AI's capabilities in your GitLab projects. Happy coding!

Manual Setup

Follow these steps to set up Archie AI for your Gitlab repositories manually in the case of automatic setup does't work for you.

  1. Install Archie AI Application in your Gitlab Repo: - Click on PR Review from the ArchieAI Dashboard. Then click on Switch to Gitlab / Connect with Gitlab button and which redirects you to the Gitlab oauth application screen where you need to grant the access to ArchieAI Application. Come back again and choose your repository from the list.
Recommendations
  • Create a dedicated user for ArchieAI - This ensures the user is exclusively for ArchieAI, allowing better access control and .
  • Use "ArchieAI" as the username - This makes the user easily recognizable for future reference.
  • Use a dedicated email address - This helps in easy identification and management.
Setup Configuration
  1. Setup Configuration: - After selecting the repository, copy the gitlab webhook secret and store it somewhere. Now choose your settings and click on Add new configuration. Obviously, if you do not have a secret, please contact us.
Setup Configuration
  1. Setup Gitlab Webhooks for the Repo: - Now we need to set up webhooks for us to receive events. Go to the Gitlab dashboard and navigate to your project page. Click on webhooks from settings inside the left menu.
Setup Configuration
  1. Register a new webhook: - Click on Add new webhook to register the webhook.
Setup Configuration
  1. Webhook Settings: - In the URL Box add the following URL:- https://cw-backend-4stsku3jna-wl.a.run.app/git-service/gitlab/webhook (opens in a new tab). Inside the Secret Token Box, fill the secret token which you copied in Step 2. Now select all the events including Push, Tag Push, Comments, Issues, Merge Requests, Emoji events. Enable SSL verification: Check the box and click save.
Setup Configuration
  1. Good to Go!: - Yayy! You are good to go now. Open a new merge request and see the app in action!

Visit the Archie AI website to update your configuration settings.

PR ReviewMusicalmadness