Процес розгортання регламенту в Gerrit

🌐 Цей документ доступний українською та англійською мовами. Використовуйте перемикач у правому верхньому куті, щоб змінити версію.

Для розгортання заздалегідь підготовленого регламенту реєстру, дотримуйтеся кроків, поданих нижче на цій сторінці.

Для перегляду списку основних елементів регламенту реєстру, зверніться до секції Структура регламенту реєстру.

Крок 1

Відкрийте Gerrit реєстру та виконайте вхід.

Посилання до системи рецензування коду Gerrit можливо отримати в Openshift-консолі. Для цього перейдіть до розділу Networking → Routes, оберіть відповідний проєкт, в рядку пошуку вкажіть назву сервісу gerrit, після чого посилання буде доступне у колонці Location.

registry deploy regulation 04

Після успішної авторизації перейдіть до розділу Browse → Repositories. Вам буде доступний репозитарій з регламентом реєстру — registry-regulations.

registry deploy regulation step 1

Крок 2

Перейдіть до репозиторію registry-regulations (натиснувши назву репозиторію) та скопіюйте виділену червоним команду для локального завантаження репозиторію, тобто виконайте git clone. Це посилання необхідно для того, щоб виконати копіювання віддаленого репозиторію на локальну машину.

registry deploy regulation step 2

Крок 3

Запустіть Git Bash-консоль у директорії (папці), до якої необхідно склонувати репозиторій. Вставте та виконайте скопійовану команду з попереднього кроку 2.

registry deploy regulation 01

Username та Password можливо отримати у профілі користувача в Gerrit, у розділі Settings → User Settings → HTTP Credentials.

registry deploy regulation step 4

registry deploy regulation 03

Після успішного копіювання віддаленого репозиторію він стане доступний на локальній машині.

Крок 4

Розкладіть попередньо підготовлені файли регламенту (наприклад, ті, що були отримані при передачі архіву з регламентом вже розробленого реєстру або відредаговані файли зі змінами) до відповідних директорій каталогу registry-regulations.

Відкрийте Git Bash-термінал у директорії, в якій розташовано підготовлений до розгортання регламент.

registry deploy regulation 05

Виконайте у Git Bash-терміналі наступні команди:

git add .
git commit -m "Message commit with changes"
git push origin HEAD:refs/for/master

де:

git add . — означає додати всі файли (локально);
git commit -m "Message commit with changes":
- git commit — внесення змін до регламенту реєстру (локально);
- -m — атрибут коментаря до змін;
- "Message commit with changes" — коментар до змін, що вносяться до регламенту;
git push origin HEAD:refs/for/master:
- git push origin — команда відправлення локальних змін до віддаленого репозиторію з регламентом реєстру;
- HEAD:refs/for/master — шлях до майстер-гілки віддаленого репозиторію.

В результаті виконання зазначених команд, локальні файли регламенту будуть розгорнуті у Gerrit-репозиторії.

Крок 5

Перейдіть до Gerrit → Changes → Open та переконайтеся, що зміна створена.

registry deploy regulation step 6

Крок 6

Виконайте процедуру рецензування, увійшовши до створеної зміни.

Натисніть Reply

user management 53

У новому вікні, натисніть наступні кнопки оцінки:

+2 — для Code-Review;

+1 — для Verified.

+1 для Verified можна встановити вручну, але необов’язково. Рекомендуємо дочекатися автоматичної перевірки через Jenkins-пайплайн (CI Jenkins). Це може зайняти кілька хвилин.

user management 54

Натисніть SEND, а далі SUBMIT для застосування зміни у віддаленому репозиторії (git merge).

user management 55

У спливному вікні натисніть CONTINUE для підтвердження.

Крок 7

В Gerrit перейдіть до розділу Changes → Merged. Знайдіть зміну, перейдіть до неї та переконайтеся, що CI Jenkins-пайплайн публікації регламенту із назвою MASTER-Build-registry-regulations запущено, та дочекайтеся успішного його завершення.

Перевірити виконання pipeline можна:
- за посиланням CI Jenkins у секції Change Log;
- або перейдіть до Jenkins job за посиланням, що доступне внизу сторінки.
У новому вікні зліва натисніть Back to Project.
Переконайтеся, що збірка пройшла успішно. В такому разі усі етапи збірки виконано без помилок, а всі етапи процесу позначені зеленим кольором.

У разі, якщо збірка регламенту була виконана з помилкою, наприклад, якщо регламент не пройшов серверну валідацію, в такому випадку необхідно визначити причину помилки (знайти її в логах), усунути причину помилки, після чого повторно виконати внесення змін.

Приклад пошуку та виявлення помилок у журналі подій (логах) Jenkins доступний за посиланням.

Після успішного виконання Jenkins job, сутності регламенту реєстру створено і можливо переходити до їх перевірки.