Перейти к содержанию

Подключение системы контроля версий

Для добавления в систему проектов (Git репозиториев) на анализ необходимо предварительно создать подключение к системе контроля версий (VCS). CodeScoring поддерживает следующие платформы, использующие Git:

  • GitLab
  • GitHub
  • BitBucket (только Data Center и Server)
  • Azure DevOps Git
  • Other Git (другие платформы, использующие Git)

Интеграция происходит через два возможных механизма: Personal Access Token или ключ SSH. Для механизма Personal Access Token возможно подключение нескольких систем контроля версий с одним адресом, но разными токенами.

После подключения системы контроля версий невозможно поменять ее тип (Instance type) и адрес (Instance URL).

Примечание: в случае, если для обращения к системе контроля версий используются приватные NS сервера, их надо указать в настройках инсталляции. Для получения соответствующих шаблонов необходимо обратиться к вендору.

Добавление SSH-ключа

  1. Скопировать существующий или сгенерировать новый приватный SSH ключ в системе контроля версий по инструкции для:
  2. В интерфейсе CodeScoring перейти в раздел Settings -> SSH Keys
  3. Нажать Setup new в правом верхнем углу.
  4. Заполнить форму. Приватный SSH ключ вставляется в поле Instance private key.
  5. Перейти в раздел Settings -> VCS.
  6. Нажать Setup new в правом верхнем углу.
  7. Заполнить форму, как показано на скриншоте. SSH ключ выбирается из списка в поле SSH key. VCS form with SSH key
  8. Проверить подключение можно по кнопке Test it. Для создания подключения необходимо нажать на кнопку Setup now.

Добавление токена для GitLab

Оригинальная инструкция для генерации токена на английском: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token

  1. Войти в свой аккаунт в GitLab, для облачной версии логин доступен по ссылке https://gitlab.com/users/sign_in.

  2. Через меню пользователя в правом верхнем углу перейти в раздел Edit profile.

    Edit profile

  3. Далее в левом меню выбрать раздел Access Tokens.

    Access tokens

  4. Задать название токену, например, "codescoring-demo", дату можно оставить пустой

  5. В секции scopes выбрать read_api и read_repository. Token scopes
  6. Нажать кнопку Create personal access token.
  7. Скопировать сгенерированный токен.
  8. В интерфейсе CodeScoring перейти в раздел Settings -> VCS.
  9. Нажать Setup new в правом верхнем углу.
  10. Заполнить форму, как показано на скриншоте. Токен вставляется в поле Access token. VCS form for GitLab

Добавление токена для GitHub

Оригинальная инструкция для генерации токена на английском: https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

  1. Войти в свой аккаунт в GitHub, для облачной версии логин доступен по ссылке https://github.com/login.
  2. Если у аккаунта не верифицирован email, обязательно это сделать по инструкции.
  3. Через меню пользователя в правом верхнем углу перейти в раздел Settings.
  4. Далее в левом меню выбрать раздел Developer settings.
  5. В левом меню выбрать раздел Personal access tokens.
  6. Задать название токену, например, "codescoring-demo".
  7. В секции Select scopes выбрать все опции списка repos.
  8. Нажать кнопку Generate token.
  9. Скопировать сгенерированный токен.
  10. В интерфейсе CodeScoring перейти в раздел Settings -> VCS.
  11. Нажать Setup new в правом верхнем углу.
  12. Заполнить форму, как показано на скриншоте. Токен вставляется в поле Access token. VCS form for GitHub

Добавление токена для BitBucket Data Center и Server

Оригинальная инструкция для генерации токена на английском: https://confluence.atlassian.com/bitbucketserver072/personal-access-tokens-1005335924.html

  1. Войти в свой аккаунт в BitBucket.
  2. Через меню пользователя в правом верхнем углу перейти в раздел Manage account.
  3. Далее в левом меню выбрать раздел Personal access tokens.
  4. Нажать на Create token.
  5. Задать название токену, например, "codescoring-demo".
  6. В секции Permissions дать права на чтение для проектов и репозиториев.
  7. В секции Expiry при желании задать срок жизни токена.
  8. Нажать кнопку Create.
  9. Скопировать сгенерированный токен.
  10. В интерфейсе CodeScoring перейти в раздел Settings -> VCS.
  11. Нажать Setup new в правом верхнем углу.
  12. Заполнить форму, как показано на скриншоте. Токен вставляется в поле Access token. VCS form for BitBucket Server

Добавление токена для Azure DevOps Git

Оригинальная инструкция для генерации токена на английском: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops

  1. Войти в свой аккаунт в Azure DevOps.

  2. Через меню пользователя в правом верхнем углу перейти в раздел Personal access tokens.

    PAT menu item

  3. Далее нажать кнопку New token.

  4. Задать название токену, например, "codescoring-demo", и срок действия токена.
  5. В секции Scopes обязательно отметить доступ на Read для сущностей Code и Identity.
  6. Нажать кнопку Create.
  7. Скопировать сгенерированный токен.
  8. В интерфейсе CodeScoring перейти в раздел Settings -> VCS.
  9. Нажать Setup new в правом верхнем углу.
  10. Заполнить форму, как показано на скриншоте. Токен вставляется в поле Access token. VCS form for Azure