Prepare your GitLab group

A Gryndel workspace belongs to one GitLab group and covers its subgroups and projects. Before you create one, make sure you have the right access and that Gryndel's GitLab user can see your group.

If your team uses GitHub, follow Prepare your GitHub account instead.

What you need

• Owner or Maintainer access to the GitLab group. Only they can create its workspace.
• Maintainer access to each project you want reviewed. Turning on reviews adds a webhook to the project as you, and GitLab only lets Maintainers do that.

Make a reviewer account for Gryndel

Gryndel reads code and posts reviews in your group as a GitLab account you control, its reviewer account. Comments appear under that account's name. You give Gryndel its token when you create the workspace; nobody outside your organisation needs access to your group.

Choose one:

• A GitLab user made for Gryndel (works on every GitLab plan):
  1. Sign up a new GitLab user, for example gryndel-yourteam, with its own email address. Name it Gryndel so people recognise its comments. The username can be anything: commands work with @gryndel as well as with the username.
  2. Signed in as that user, open Edit profile → Access tokens → Add new token. Choose the scope api and an expiry date (at most a year on GitLab.com), and copy the token: GitLab shows it once.
  3. In your group, open Manage → Members → Invite members, enter the user's username and choose the role Developer.
• A group access token (GitLab Premium or Ultimate): in your group, open Settings → Access tokens → Add new token, choose the role Developer and the scope api, and copy the token. GitLab creates the token's bot user and adds it to the group for you.

Don't use your own account's token: reviews would appear as you, and the token would carry all your access, not only this group's.

The projects in the group and its subgroups inherit the reviewer's access. Keep the token for the next step; Gryndel stores it encrypted and never shows it again.

If your Gryndel offers a shared account

Some Gryndel operators allow a shared reviewer instead. Then the New workspace dialog offers Use Gryndel's shared account, and you add that account (usually gryndel) to your group as a Developer instead of making your own.

Why Developer, not higher?

Developer is enough to read code, post and resolve its own comments, and set commit statuses. It can't change your project settings. Gryndel never needs Maintainer: people manage webhooks themselves, with their own access.

Self-applied fixes

If you plan to use Suggest and apply fixes (Gryndel commits its suggestions to the source branch), Gryndel must be able to push to those branches. Protected branches may block it. See the Findings tab in Repositories.

Next: Create a workspace.