Gitlab CE में कोड समीक्षा: यदि कोई मर्ज अनुरोध अनुमोदन नहीं है, लेकिन मैं वास्तव में चाहता हूं

सबसे आवश्यक विशेषताओं में से एक जो GitLab के मुक्त संस्करण में नहीं है, अनिवार्य कोड समीक्षा का उपयोग करके मर्ज अनुरोध (MR) को नियंत्रित करने के लिए रिपॉजिटरी को शून्य करने के खिलाफ मतदान करने की क्षमता है।

हम न्यूनतम कार्यक्षमता स्वयं करेंगे - हम तब तक मर्ज को अक्षम कर देंगे जब तक कि कई डेवलपर MR को "थम्स अप" न दें।

ऐसा बिल्कुल क्यों है?

हमारा संगठन GitLab लाइसेंस खरीदने का खर्च वहन कर सकता है। लेकिन, चूंकि इंटरनेट तक पहुंच के बिना बंद लूप में विकास किया जाता है, और एक सख्त बजट योजना है, आवश्यक कार्यक्षमता के साथ स्व-प्रबंधित लाइसेंस की खरीद में कई महीने लग सकते हैं, और आपको अभी काम करने की आवश्यकता है।

नतीजतन, आपको यह करना होगा:

• या कुछ डेवलपर्स के लिए पूरी तरह से संरक्षित शाखाओं में मर्ज को प्रतिबंधित करें, लेकिन फिर जिन डेवलपर्स को मर्ज करने का अधिकार है, वे अन्य लोगों के एमआर को बोनस के रूप में मर्ज करते समय विरोध प्राप्त करते हैं;
• या आपको कोड समीक्षा के बिना अपनी मास्टर शाखा के साथ अनियंत्रित विलय करने की अनुमति देता है, भले ही वह एक जूनियर हो जो कल ही बस गया हो।

मैंने जो पहला काम किया, वह था Google जाना, यह विश्वास करना कि किसी ने पहले से ही कुछ ऐसा ही किया है (कोड को परिष्कृत किए बिना), लेकिन यह पता चला कि सामुदायिक संस्करण में अभी तक ऐसा कोई कार्यान्वयन नहीं हुआ है।

कार्य की सामान्य योजना

एक उदाहरण के रूप में, आइए परीक्षण रिपॉजिटरी पर मर्ज अनुरोध अनुमोदन सेट अप करें MyApp:

1. आइए GitLab API तक पहुँचने के लिए एक टोकन बनाएँ (इसके माध्यम से हमें वोटों की संख्या के बारे में और इसके खिलाफ जानकारी प्राप्त होगी)
2. GitLab चर में एक टोकन जोड़ें
3. यदि पाइपलाइन में त्रुटियां हैं तो विलय को अक्षम करें (यदि "मतों के लिए" पर्याप्त नहीं हैं)
4. सीआई/सीडी पाइपलाइन के हिस्से के रूप में वोट सत्यापन सेट अप करें
5. हम संरक्षित शाखाओं को कमिट करने पर रोक लगा देंगे, हम सभी परिवर्तन केवल MR के माध्यम से करते हैं
6. आइए देखें कि अंत में क्या हुआ

1. एपीआई तक पहुंचने के लिए एक टोकन बनाएं

उपयोगकर्ता सेटिंग्स पर जाएं → टोकन एक्सेस करें और टोकन लिखें:

टोकन प्राप्त करने के लिए खाता
एपीआई एक्सेस आपको अपने रिपॉजिटरी के साथ लगभग कुछ भी करने की अनुमति देता है, इसलिए मेरा सुझाव है कि आप एक अलग गिटलैब खाता बनाएं, इसे अपने रिपॉजिटरी (जैसे रिपोर्टर) को न्यूनतम अधिकार दें और उस खाते के लिए एक टोकन प्राप्त करें।

2. Gitlab वेरिएबल्स में टोकन जोड़ें

उदाहरण के लिए, पिछले चरण में, हमें एक टोकन मिला था QmN2Y0NOUFlfeXhvd21ZS01aQzgK

ओपन सेटिंग्स → सीआई / सीडी → वेरिएबल्स → वेरिएबल जोड़ें → GITLAB_TOKEN_FOR_CI

परिणामस्वरूप, हमें मिलता है:

यह एक रिपॉजिटरी और रिपॉजिटरी के समूह दोनों पर किया जा सकता है।

3. कोड समीक्षा के बाद सहयोगियों की स्वीकृति प्राप्त नहीं होने पर हम मर्ज पर प्रतिबंध लगाते हैं

हमारे मामले में, मर्ज पर प्रतिबंध यह होगा कि पर्याप्त वोट न होने पर असेंबली पाइपलाइन एक त्रुटि वापस कर देगी।

सेटिंग्स → सामान्य → मर्ज अनुरोध → मर्ज चेक पर जाएं और विकल्प को सक्षम करें असेंबली लाइन सफलतापूर्वक चलना चाहिए।

4. पाइपलाइन सेट करें

यदि आपने अभी तक अपने आवेदन के लिए सीआई/सीडी पाइपलाइन नहीं बनाई है
रिपॉजिटरी के रूट में एक फाइल बनाएं .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"

सीआई/सीडी कॉन्फ़िगरेशन के लिए अलग रिपॉजिटरी
मैं एक अलग रिपॉजिटरी बनाने की सलाह दूंगा जहां आपको पाइपलाइन स्थापित करने के लिए myapp.gitlab-ci.yml फ़ाइल बनाने की आवश्यकता है। इस तरह आप उन योगदानकर्ताओं की पहुंच को बेहतर ढंग से नियंत्रित कर सकते हैं जो बिल्ड पाइपलाइन को बदल सकते हैं और एक्सेस टोकन प्राप्त कर सकते हैं।

नई पाइपलाइन फ़ाइल का स्थान myapp रिपॉजिटरी में जाकर निर्दिष्ट करने की आवश्यकता होगी - सेटिंग्स - CI / CD - असेंबली लाइन्स - कस्टम CI कॉन्फ़िगरेशन पथ - एक नई फ़ाइल निर्दिष्ट करें, उदाहरण के लिए myapp.gitlab-ci.yml@gitlab-ce-mr-approvals/Ci

युक्ति: GitLab CI फ़ाइलों में परिवर्तन करने के लिए लिंटर का उपयोग करें
यहां तक ​​कि अगर आप अकेले काम करते हैं, एमआर के माध्यम से काम करना एक अच्छा सहायक होगा, आपके सभी परिवर्तनों को लिंटर के माध्यम से पाइपलाइन फाइलों में चलाना। यदि आप YAML फ़ाइल के सिंटैक्स में गलती करते हैं, तो यह आपको काम करने वाली पाइपलाइन को तोड़ने की अनुमति नहीं देगा, लेकिन मर्ज को ब्लॉक कर देगा।

लिंटर वाले कंटेनरों का एक उदाहरण जिसे आप अपनी पाइपलाइन में एम्बेड कर सकते हैं:

hub.docker.com/r/gableroux/gitlab-ci-lint
hub.docker.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 में कितने "थम्स अप" होने चाहिए। एक के मूल्य का अर्थ है कि आप स्वयं अपने एमआर को "पसंद" करके अनुमोदित कर सकते हैं।

शामिल में परीक्षण चरण शामिल है, जो "पसंद" की संख्या की जांच करता है।

उदाहरण के तौर पर 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/.*$/'


जाँच करने पर क्या होता है, इसके बारे में और जानें:

• प्रतिबंध सेट है कि चेक केवल मास्टर या रिलीज /* शाखाओं में एमआर बनाते समय होगा
• GitLab API का उपयोग करके, "पसंद" और "नापसंद" की संख्या प्राप्त करें
• सकारात्मक और नकारात्मक प्रतिक्रियाओं के बीच अंतर की गणना करें
• यदि अंतर हमारे द्वारा NEED_VOTES में निर्धारित मान से कम है, तो हम मर्ज करने की क्षमता को अवरुद्ध कर देते हैं

5. संरक्षित शाखाओं को अक्षम करें

हम उन शाखाओं का निर्धारण करते हैं जिनके लिए हमें कोड की समीक्षा करनी चाहिए और इंगित करते हैं कि केवल एमआर के माध्यम से ही उन पर काम किया जा सकता है।

ऐसा करने के लिए, सेटिंग → रिपॉजिटरी → संरक्षित शाखाओं पर जाएँ:

6. जाँच करना

NEED_VOTES सेट करें: 0

हम एमआर करते हैं और "नापसंद" डालते हैं।

बिल्ड लॉग में:

अब "लाइक" डालें और फिर से चेक करें:

स्रोत: www.habr.com