Tudnivalók a lekéréses kérelmekről
Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019
A lekéréses kérelmek (PRS- k) az Azure-adattárak Git-adattárában lévő kód módosításának, felülvizsgálatának és egyesítésének módjai. A PRS-ek származhatnak ugyanahhoz az adattárhoz tartozó ágakból vagy az adattár elágazásaiból. A csapatok pR-k használatával ellenőrzik a kódot, és visszajelzést adnak a változásokról, mielőtt a kódot a főágba egyesítenének. A véleményezők végiglépkedhetnek a javasolt módosításokon, megjegyzéseket hagyhatnak, és szavazhatnak a kód jóváhagyására vagy elutasítására.
Ez a cikk a lekéréses kérelmekre vonatkozó irányelveket és felügyeleti szempontokat ismerteti. A lekéréses kérelmek létrehozásáról, megtekintéséről, áttekintéséről és befejezéséről az alábbi cikkekben olvashat:
- Lekéréses kérelmek létrehozása
- Lekéréses kérelmek megtekintése és megnyitása
- Lekéréses kérelmek áttekintése
- Lekéréses kérelmek befejezése
Feljegyzés
Teljesítmény- és stabilitási okokból a lekéréses kérelmekhez hozzáadható felülvizsgálók számának legalább 1000-nek kell lennie. A rendszer nem hoz létre új lekéréses kérelmeket, ha több mint 1000 véleményezőt ad hozzá, és a meglévő lekéréses kérelmek nem teszik lehetővé több mint 1000 véleményező hozzáadását.
Engedélyek és előfeltételek
Az adattáraknak engedélyezve kell lenniük a projektben. Ha az Adattárközpont és a kapcsolódó lapok nem jelennek meg, tekintse meg az Azure DevOps-szolgáltatás be- és kikapcsolása az újravehető adattárakhoz című témakört.
A PRs megtekintéséhez vagy áttekintéséhez egy Azure DevOps-projekt tagjának kell lennie, amely alapszintű hozzáféréssel vagy magasabb szintű hozzáféréssel rendelkezik.
- Ha nincs projektje, hozzon létre egyet, vagy regisztráljon ingyenesen.
- Ha nem tagja a projektnek, a rendszer hozzáadja.
A lekéréses kérelemhez való hozzájáruláshoz az Olvasók biztonsági csoport tagjának kell lennie, vagy rendelkeznie kell a megfelelő engedélyekkel.
A lekéréses kérelem létrehozásához és elvégzéséhez a Közreműködők biztonsági csoport tagjának kell lennie, vagy rendelkeznie kell a megfelelő engedélyekkel.
Feljegyzés
Nyilvános projektek esetén az érdekelt feleknek hozzáférést biztosító felhasználók teljes hozzáféréssel rendelkeznek az Azure-adattárakhoz.
- Az adattáraknak engedélyezve kell lenniük a projektben. Ha az Adattárközpont és a kapcsolódó lapok nem jelennek meg, tekintse meg az Azure DevOps-szolgáltatás be- és kikapcsolása az újravehető adattárakhoz című témakört.
- A PRs megtekintéséhez vagy áttekintéséhez egy Azure DevOps-projekt tagjának kell lennie, amely alapszintű hozzáféréssel vagy magasabb szintű hozzáféréssel rendelkezik. Ha nem tagja a projektnek, a rendszer hozzáadja.
- A lekéréses kérelemhez való hozzájáruláshoz az Olvasók biztonsági csoport tagjának kell lennie, vagy rendelkeznie kell a megfelelő engedélyekkel.
- A lekéréses kérelem létrehozásához és elvégzéséhez a Közreműködők biztonsági csoport tagjának kell lennie, vagy rendelkeznie kell a megfelelő engedélyekkel.
Az engedélyekről és a hozzáférésről további információt az Alapértelmezett Git-adattár és ágengedélyek, valamint a Hozzáférési szintek ismertetése című témakörben talál.
Minőségi visszajelzés lekéréses kérelmekhez
A kiváló minőségű felülvizsgálatok kiváló minőségű visszajelzésekkel kezdődnek. Íme néhány kulcs a nagy PR-visszajelzéshez:
- A lekéréses kérelem tulajdonosának rendelkeznie kell a megfelelő személyekkel, akik áttekintik a lekéréses kérelmet, és győződjön meg arról, hogy a véleményezők tudják, mit tesz a kód.
- A véleményezőknek végrehajtható, konstruktív visszajelzést kell adniuk.
- A tulajdonosoknak és a véleményezőknek gyorsan kell megjegyzéseket fűzni és válaszolniuk.
A PR-tulajdonosoknak a következőnek kell lennie:
- Győződjön meg arról, hogy a megfelelő véleményezőket választja ki a lekéréses kérelemhez való hozzárendeléshez.
- Olyan véleményezőket is felvehet, amelyek tudják, hogyan működik a kód.
- Kérje meg a más területeken dolgozó fejlesztőket, hogy oszthassák meg ötleteiket.
- Adja meg a módosítások egyértelmű leírását.
- Útmutatást adhat a véleményezőknek a lekéréses kérelmek sablonjaihoz.
- Adja meg a kód buildjét a benne futó javítással vagy szolgáltatással.
- Válaszoljon a megjegyzésekre, fogadja el a javaslatot, vagy magyarázza el, hogy miért nem ideális a javasolt módosítás.
- A kérelemkérés hatókörén kívül eső jó javaslatokhoz hozzon létre új munkaelemeket, ágakat és PRS-eket a módosítások elvégzéséhez.
A véleményezőknek a következő feladatokat kell elvégeznie.
- Visszajelzés küldése azokkal a módosításokkal kapcsolatban, amellyel nem értenek egyet
- Problémák azonosítása és konkrét javaslatok küldése a különböző teendőkre
- Győződjön meg arról, hogy a visszajelzés egyértelmű szándékkal rendelkezik, és könnyen érthető
- Megjegyzések hagyása vagy szavazás a módosításokról
További információt a Git lekéréses kérelmeivel kapcsolatos visszajelzésekért lásd.
Ágszabályzatok és lekéréses kérelmek
Előfordulhat, hogy a csapat az adattárban lévő kritikus ágakra, például az main
ágra támaszkodik, hogy mindig jó állapotban legyen. Az elágaztatási szabályzatok úgy állíthatók be, hogy pRs-eket követeljenek meg a védett ágakon végzett módosításokhoz, és elutasíthatja a közvetlenül az ágakba leküldött módosításokat.
További szabályzatokat is hozzáadhat a PRS-ekhez, hogy jobb kódminőséget kényszerítsen ki a kulcságakban. Az olyan további követelmények, mint a javasolt kód tiszta felépítése vagy több véleményező jóváhagyása segíthet a kulcságak védelmében.
A lekéréses kérelemhez szükséges jóváhagyások számát egy ágszabályzatban állíthatja be. Beállíthatja azt is, hogy bizonyos véleményezők kötelezőek legyenek, vagy nem kötelezőek legyenek az összes vagy bizonyos PRS-en. A lekéréses kérelem beállítható automatikus kiegészítésre a szükséges számú jóváhagyással, még akkor is, ha más véleményezők elutasítják a módosításokat. A szükséges felülvizsgálóknak azonban jóvá kell hagyniuk a PRs-eket, mielőtt a PRS-ek egyesülhetnek. Ajánlott, hogy legalább két felülvizsgáló áttekintse és jóváhagyja a jelentős lekéréses kérelmek módosításait.
Ha vissza szeretné állítani a szavazatokat, amikor egy pr-szerző új módosításokat küld le, válassza a Kódáttekintők szavazatainak alaphelyzetbe állítása lehetőséget, ha új változások lépnek fel a Véleményezők fiókszabályzatában.
Az alábbi táblázat az ágak testreszabásához definiálható szabályzatokat foglalja össze. Az adattár- és ágházirendek és -beállítások áttekintéséért tekintse meg a Git-adattár beállításait és szabályzatait.
Szabályzat
Alapértelmezett
Leírás
Kikapcsolva
A lekéréses kérelmek adott számú véleményezőjének jóváhagyására van szükség.
Kikapcsolva
A nyomon követhetőség ösztönzése a csatolt munkaelemek lekéréses kérelmeken való keresésével
Kikapcsolva
Ellenőrizze, hogy az összes megjegyzés feloldva lett-e a lekéréses kérelmekben.
Kikapcsolva
Az ágelőzmények szabályozásához korlátozza a lekéréses kérelmek végrehajtásakor elérhető egyesítési típusokat.
Kikapcsolva
Adjon hozzá egy vagy több szabályzatot a kód ellenőrzéséhez a lekéréses kérelmek módosításainak előzetes egyesítésével és létrehozásával. Emellett engedélyezheti vagy letilthatja a szabályzatokat.
Kikapcsolva
Adjon hozzá egy vagy több szabályzatot, amelyek megkövetelik, hogy más szolgáltatások sikeres állapotot tegyenek közzé a lekéréses kérelmek teljesítéséhez. Emellett engedélyezheti vagy letilthatja a szabályzatokat.
Kikapcsolva
Adjon hozzá egy vagy több szabályzatot a kód véleményezőinek automatikus belefoglalásához, amikor a lekéréses kérelmek módosítják a kód bizonyos területeit. Emellett engedélyezheti vagy letilthatja a szabályzatokat.
További információk:
- Ágszabályzatok áttekintése
- Ágszabályzatok konfigurálása
- Ágengedélyek
- Egyéni ágszabályzatok létrehozása az Azure Functionsszel
Állapotellenőrzések definiálása a kódminőség javítása érdekében
A lekéréses kérelmek és az ágszabályzatok segítségével a csapatok betartatják a kód áttekintésére és az automatizált buildek futtatására vonatkozó ajánlott eljárásokat. Sok csapatnak további követelményei és ellenőrzései vannak a kóddal kapcsolatban. Ezeknek az igényeknek a kielégítése érdekében integrálhatja a PR-állapotellenőrzéseket a PR-munkafolyamatba. A pr állapot-ellenőrzésekkel a külső szolgáltatások programozott módon bejelentkezhetnek a kódmódosításokra a sikeres vagy hibainformációk társításával a lekéréses kérelemmel.
További információért tekintse át az alábbi cikkeket:
- Lekéréses kérelem munkafolyamatainak testreszabása és kiterjesztése lekéréses kérelmek állapotával
- PR-állapotkiszolgáló létrehozása Node.js
- Ágszabályzat konfigurálása külső szolgáltatásra vonatkozóan
Több egyesítési alappal kapcsolatos probléma
Bizonyos esetekben a lekéréses kérelem több valódi egyesítési bázissal rendelkezik, és ez a helyzet biztonsági problémákat okozhat. Ha a lekéréses kérelemben szereplő fájlok különböző verziójúak az egyesítési alapok között, több, egyesítési alappal kapcsolatos figyelmeztetés történik. További információ és szervizelés: Több egyesítési alap.
Következő lépések
- A kódminőség javítása ágszabályzatokkal
- Lekéréses kérelem munkafolyamatainak testreszabása és kiterjesztése lekéréses kérelmek állapotával
- A lekéréses kérelmek frissítési értesítései
- Az alapértelmezett ág módosítása
- Módosítások másolása cseresznye-pick használatával
- Stratégiák és összevonási stratégiák egyesítése
- Több egyesítési alap