Правила сканирования
Просмотр правил сканирования
Пользователь может просматривать информацию о правилах проверок, которые входят в функционал Gitlife. Правила можно фильтровать по языку программирования, к которому эти правила применяются, инструменту сканирования, типу правила и уровню критичности.
Для того, чтобы посмотреть информацию о правиле необходимо:
1. Перейти на вкладку “Rule List” нажав на нее
2. Выбрав интересующее правило нажать на кнопку “Details”
3. Система покажет информацию о правиле, включая его объяснение и примеры
Экспорт правил сканирования
Пользователь может экспортировать все правила в формате CSV для этого необходимо:
1. Перейти на вкладку “Rule List” нажав на нее
2. Выбрав интересующее правило нажать на кнопку “Export Rule File”
3. Начнется скачивание файла в формате CSV со списком всех правил системы
Редактирование правил
Пользователь может редактировать описание, пример и другую информацию правила. Для этого необходимо:
1. Перейти на вкладку “Rule List” нажав на нее
2. Выбрав интересующее правило нажать на кнопку “Edit”
3. Появится окно редактирования правила, где пользователь может изменить необходимые параметры
Наборы правил сканирования
**
**Добавляя пользовательскую схему сканирования или набор правил в схему сканирования пользователь может определять те правила, которые будут использоваться при сканировании в зависимости от языка кодовой базы.
Добавление нового набора правил
Для того, чтобы добавить новый набор правил, пользователю необходимо:
1. Нажать на кнопку “Rule Set” в меню навигации для перехода в данный раздел
Пользователь увидит список наборов правил, используемых системой
2. Нажать на кнопку “New Rule Set”, и заполнить всю необходимую информацию
3. После заполнения всех параметров и нажатия на кнопку “Sure” новый набор правил будет добавлен
Просмотр информации о наборе правил
**
**Пользователь может просматривать детальную информацию о наборе правил
Для этого необходимо:
1. Нажать на кнопку “Rule Set” в меню навигации для перехода в данный раздел
Пользователь увидит список наборов правил, используемых системой
2. Нажать на интересующий набор правил
3. Система покажет всю информацию о интересующем наборе правил, в том числе, список правил входящих в него
Копирование набора правил
**
**Пользователь может копировать добавленный набор правил, если необходимо добавить несколько наборов с похожими параметрами. Для этого необходимо:
1. Нажать на кнопку “Rule Set” в меню навигации для перехода в данный раздел. Пользователь увидит список наборов правил, используемых системой
2. На странице со всеми наборами правил нажать на иконку троеточия, которая располагается в правой стороне строчки интересующего набора
2. В появившемся выпадающем списке нажать на кнопку " Copy"
3. Система добавит новый набор правил, скопировав параметры с выбранного пользователем набора
Удаление пользовательского набора правил
**
**Пользователь может удалить добавленный набор правил, если он не планируется к использованию. Для этого необходимо:
1. Нажать на кнопку “Rule Set” в меню навигации для перехода в данный раздел. Пользователь увидит список наборов правил, используемых системой
2. На странице со всеми наборами правил нажать на иконку троеточия, которая располагается в правой стороне строчки интересующего набора
2. В появившемся выпадающем списке нажать на кнопку **"Delete"
**3. Система покажет форму подтверждения удаления.
4. После подтверждения набор будет удален из списка наборов правил
Инструкции сканирования кода
**
**Настройки сканиро вания кодовой базы одинаковые для всех типов сканирования и для все разделов Gitlife. Ниже приведены примеры настроек для разных модулей.
(На иллюстрации выше, [Сканирование репозитория] настройки сканирования)
(На иллюстрации выше, [Быстрое сканирование] настройки сканирования)
(На иллюстрации выше, настройки сканирования Gitlife Code)
(На иллюстрации выше, настройки сканирования Gitlife Pipe's)
Использование стандартной схемы сканирования
Настройка сканирования кодовой базы одинаковая для всех типов и всех модулей Gitlife. The configuration logic of code scanning is consistent. Рассмотрим данную настройку на примере сканирования репозитория:
1. Пользователь должен перейти в модуль Scan нажав на соответствующую кнопку в панеле навигации, которая расположена с правой стороны
2. Система откроет страницу с добавленными репозиториями
3. Пользователю необходимо нажать на значок сканирования
4. Система откроет окно с настройками санирования.
5. В данном окне пользователю доступны следующие настройки:
- Настройки сканирования – с помощью этой настройки пользователь может моментально начать сканирование или запланировать на указанную дату
- Уровень сканирования – данная настройка отвечает за уровень критичности правил, которые будут использоваться при проверке.
- Схема сканирования – пользователь может выбрать либо стандартную схему сканирования, которая сконфигурирована по умолчанию, или выбрать сконфигурированную пользователем ранее схему.
- Контроль качества – пользователь может сканировать кодовую базу целиком, или сканировать только те файлы репозитория, которые были изменены.
- Адрес репозитория – адрес репозитория, который будет сканироваться
Замечание: если пользователь использует стандартную схему сканирования, то скорость сканирования может быть низкой из-за большого объема правил. Не рекомендуется использовать эт у схему для ежедневных использований. Для того, чтобы сократить время сканирования рекомендуется настроить пользовательские схемы с необходимыми правилами.
6.Пользователь может выбрать необходимую схему сканирования.