סקירת קוד ב-Gitlab CE: אם אין אישורי בקשת מיזוג, אבל אני מאוד רוצה

אחת הפונקציות הנחוצות ביותר, שאינה בגרסה החינמית של GitLab, היא היכולת להצביע נגד ביטול מאגר ושליטה בבקשת מיזוג (MR), באמצעות סקירת הקוד המחייבת.

בואו נעשה את הפונקציונליות המינימלית בעצמנו - נאסור על מיזוג עד שכמה מפתחים יתנו אגודל ל-MR.

למה זה בכלל נחוץ?

הארגון שלנו יכול להרשות לעצמו בקלות לקנות רישיון GitLab. אבל, מכיוון שהפיתוח מתבצע בלולאה סגורה ללא גישה לאינטרנט, ויש תכנון תקציבי קפדני, רכישת רישיונות בניהול עצמי עם הפונקציונליות הדרושה יכולה להימשך חודשים רבים, אבל צריך לעשות עבודה עכשיו.

כתוצאה מכך עליך:

• או לאסור לחלוטין מיזוג בסניפים מוגנים עבור מפתחים מסוימים, אבל אז מפתחים שיש להם את הזכות למיזוג מקבלים התנגשויות בעת מיזוג MRs של אנשים אחרים כבונוס;
• או תן את ההזדמנות לבצע מיזוגים בלתי מבוקרים עם סניף המאסטר שלך ללא סקירת קוד, גם אם זה ג'וניור, שהתקבל לעבודה רק אתמול.

הדבר הראשון שעשיתי היה גוגל, מתוך אמונה שמישהו בהחלט כבר עשה משהו דומה (בלי לשנות את הקוד), אבל התברר שעדיין לא היה יישום כזה בגרסת הקהילה.

תכנית עבודה כללית

כדוגמה, בואו נגדיר אישורי בקשות מיזוג במאגר בדיקה מייאפ:

1. בואו ניצור אסימון לגישה ל-GitLab API (דרכו נקבל מידע על מספר ההצבעות "בעד" ו"נגד")
2. בואו נוסיף את האסימון למשתני GitLab
3. בואו נשבית את המיזוג במקרה של שגיאות בצנרת (אם אין מספיק הצבעות בעד)
4. בואו נגדיר את אימות ההצבעה כחלק מצינור ה-CI/CD
5. אנו אוסרים על התחייבויות לסניפים מוגנים; כל השינויים מתבצעים רק באמצעות MR
6. בוא נבדוק מה קרה בסוף

1. צור אסימון לגישה ל-API

עבור אל הגדרות משתמש ← Access Tokens ורשום את האסימון:

חשבון לקבלת אסימון
גישת API מאפשרת לך לעשות כמעט כל דבר עם המאגרים שלך, אז אני ממליץ ליצור חשבון Gitlab נפרד, לתת לו זכויות מינימליות למאגרים שלך (למשל Reporter) ולקבל אסימון לחשבון זה.

2. הוסף את האסימון למשתני Gitlab

למשל, בשלב הקודם קיבלנו אסימון QmN2Y0NOUFlfeXhvd21ZS01aQzgK

פתח את הגדרות ← CI/CD ← משתנים ← הוסף משתנה ← GITLAB_TOKEN_FOR_CI

כתוצאה מכך אנו מקבלים:

ניתן לעשות זאת במאגר אחד או על קבוצת מאגרים.

3. אנו שמים איסור על מיזוג אם לא יתקבל אישור של עמיתים לאחר סקירת הקוד.

במקרה שלנו, האיסור על מיזוג יהיה שצינור ההרכבה יחזיר שגיאה אם ​​לא יהיו מספיק הצבעות.

עבור אל הגדרות ← כללי ← בקשות מיזוג ← מיזוג צ'קים והפעל את האפשרות כישורי הרכבה חייבים להסתיים בהצלחה.

4. הקמת הצינור

אם עדיין לא יצרת צינור CI/CD עבור היישום שלך
צור קובץ בשורש המאגר .gitlab-ci.yml עם התוכן הפשוט ביותר:

stages:
  - build
  - test

variables:
  NEED_VOTES: 1

include:
  - remote: "https://gitlab.com/gitlab-ce-mr-approvals/ci/-/raw/master/check-approve.gitlab-ci.yml"

run-myapp:
  stage: build
  script: echo "Hello world"

מאגר נפרד עבור תצורת CI/CD
אני ממליץ ליצור מאגר נפרד שבו אתה צריך ליצור קובץ myapp.gitlab-ci.yml כדי להגדיר את הצינור. כך תוכל לשלוט טוב יותר בגישה של משתתפים שיכולים לשנות את צינור הבנייה ולקבל אסימון גישה.

יהיה צורך לציין את המיקום של קובץ הצינור החדש על ידי מעבר למאגר myapp - הגדרות - CI/CD - קווי הרכבה - נתיב תצורת CI מותאם אישית - ציין את הקובץ החדש, למשל. myapp.gitlab-ci.yml@gitlab-ce-mr-approvals/Ci

טיפ: השתמש ב-linter כדי לבצע שינויים בקבצי GitLab CI
גם אם אתה עובד לבד, עבודה דרך MR תהיה עזרה טובה, להריץ את כל השינויים שלך בקבצי צינור דרך linter. אם תעשה טעות בתחביר של קובץ ה-YAML, הוא לא ישבור את צינור הייצור שלך, אלא פשוט יחסום את המיזוג.

דוגמה למיכלים עם רצועות שתוכלו לבנות בצינור שלכם:

hub.docker.com/r/gableroux/gitlab-ci-lint
hub.docer.com/r/sebiwi/gitlab-ci-validate

ודוגמה לשלב האימות:

stages:
  - lint

lint:
  stage: lint
  image: sebiwi/gitlab-ci-validate:1.3.0
  variables:
    GITLAB_HOST: https://gitlab.com
  script:
    - CI_FILES=(./*.yml)
    - for f in "${CI_FILES[@]}"; do
        gitlab-ci-validate $f;
      done;

נותר להוסיף כמה פרמטרים לצינור שלך כדי שזה יעבוד:

stages:
- test

variables:
NEED_VOTES: 1

include:
- remote: "https://gitlab.com/gitlab-ce-mr-approvals/ci/-/raw/master/check-approve.gitlab-ci.yml"

המשתנה NEED_VOTES קובע כמה "אגודל למעלה" צריך להיות ל-MR כדי שהמיזוג יהיה זמין. ערך שווה לאחד אומר שאתה בעצמך יכול לאשר את ה-MR שלך על ידי "אהבתי" אותו.

include כולל את שלב הבדיקה, שבודק את מספר ה"לייקים".

הצינור הפשוט ביותר באמצעות הדוגמה של myapp.gitlab-ci.yml
stages:
- build
- test

variables:
NEED_VOTES: 0

include:
- remote: "https://gitlab.com/gitlab-ce-mr-approvals/ci/-/raw/master/check-approve.gitlab-ci.yml"

run-myapp:
stage: build
image: openjdk
script:
- echo CI_MERGE_REQUEST_TARGET_BRANCH_NAME $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
- java HelloWorld.java

תוכן check-approve.gitlab-ci.yml
ci-mr:
stage: test
script:
- echo ${CI_API_V4_URL}
- echo "CI_PROJECT_ID ${CI_PROJECT_ID}"
- echo "CI_COMMIT_SHA ${CI_COMMIT_SHA}"
- "export MR_ID=$(curl --silent --request GET --header "PRIVATE-TOKEN: $GITLAB_TOKEN_FOR_CI" ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests | jq ".[] | if .sha == \"${CI_COMMIT_SHA}\" then .id else {} end" | grep --invert-match {})"
- "export MR_TITLE=$(curl --silent --request GET --header "PRIVATE-TOKEN: $GITLAB_TOKEN_FOR_CI" ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests | jq ".[] | if .sha == \"${CI_COMMIT_SHA}\" then .title else {} end" | grep --invert-match {})"
- "export MR_WIP=$(curl --silent --request GET --header "PRIVATE-TOKEN: $GITLAB_TOKEN_FOR_CI" ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests | jq ".[] | if .sha == \"${CI_COMMIT_SHA}\" then .work_in_progress else {} end" | grep --invert-match {})"
- "export MR_UPVOTES=$(curl --silent --request GET --header "PRIVATE-TOKEN: $GITLAB_TOKEN_FOR_CI" ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests | jq ".[] | if .sha == \"${CI_COMMIT_SHA}\" then .upvotes else {} end" | grep --invert-match {})"
- "export MR_DOWNVOTES=$(curl --silent --request GET --header "PRIVATE-TOKEN: $GITLAB_TOKEN_FOR_CI" ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/merge_requests | jq ".[] | if .sha == \"${CI_COMMIT_SHA}\" then .downvotes else {} end" | grep --invert-match {})"
- MR_VOTES=$(expr ${MR_UPVOTES} - ${MR_DOWNVOTES})
- NEED_VOTES_REAL=${NEED_VOTES:-1}
- echo "MR_ID ${MR_ID} MR_TITLE ${MR_TITLE} MR_WIP ${MR_WIP} MR_UPVOTES ${MR_UPVOTES} MR_DOWNVOTES ${MR_DOWNVOTES}"
- echo "MR_VOTES ${MR_VOTES} Up vote = 1, down vote = -1, MR OK if votes >=${NEED_VOTES_REAL}"
- if [ "${MR_VOTES}" -ge "$(expr ${NEED_VOTES_REAL})" ];
then
echo "MR OK";
else
echo "MR ERROR Need more votes";
exit 1;
fi
image: laptevss/gitlab-api-util
rules:
- if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master" || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME =~ /^release/.*$/'


מידע נוסף על מה שקורה במהלך האימות:

• ישנה הגבלה שהבדיקה תתבצע רק בעת יצירת MR בסניפים מאסטר או שחרור/*
• באמצעות ה-API של GitLab, אנו מקבלים את מספר "אהבתי" ו-"דיסלייקים"
• לחשב את ההבדל בין תגובות חיוביות ושליליות
• אם ההפרש קטן מהערך שהגדרנו ב-NEED_VOTES, אנו חוסמים את יכולת המיזוג

5. לאסור מתחייב לענפים מוגנים

אנו מגדירים את הסניפים שלגביהם עלינו לערוך ביקורות קוד ומציינים שניתן לעבוד איתם רק דרך MR.

כדי לעשות זאת, עבור אל הגדרות ← מאגר ← סניפים מוגנים:

6. בדוק

הגדר NEED_VOTES: 0

אנחנו עושים MR ושמים "דיסלייק".

ביומני הבנייה:

כעת שים "אהבתי" והתחל לבדוק שוב:

מקור: www.habr.com