Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Azure DevOps Szolgáltatások | Azure DevOps Server | Azure DevOps Server 2022
A jó lekéréses kérelmek leírásának megírása nagyszerű módja annak, hogy a véleményezők tudják, mire számíthatnak a kód áttekintésekor. Emellett kiválóan segítenek nyomon követni azokat a dolgokat, amelyeket minden változáshoz el kell végezni, például a teszteléshez, az egységtesztek hozzáadásához és a dokumentáció frissítéséhez. A lekéréses kérelmek sablonjai segíthetnek a fejlesztőknek nagyszerű lekéréses kérelemleírások létrehozásában, amelyek megfelelnek a szervezet szabványainak.
A lekéréses kérelmek szabályzataival, a fiókszabályzatokkal és a biztonsági ajánlott eljárásokkal kapcsolatos átfogó útmutatásért lásd: Biztonságos adattárak és lekéréses kérelmek.
Ez a cikk bemutatja, miként kezdhet bele a lehívási kérelem sablonok használatába.
Megjegyzés
A lekéréses kérelmek sablonjai útmutatást nyújthatnak, de csak tanácsadást nyújtanak. Fiókszabályzatok használatával érvényesítheti az ajánlott eljárásokat, például lekéréses kérelmeket követelhet meg a kulcsfontosságú ágak, mint a main esetében, sikeres buildelést igényelhet, és megkövetelheti a szükséges felülvizsgálókat. További információ: ágszabályzatok.
Előfeltételek
| Kategória | Követelmények |
|---|---|
| Projekthez való hozzáférés | A projekttagja. |
| Jogosultságok | - Kód megtekintése magánprojektekben: Legalább Alapszintű hozzáférés. - Kód klónozása vagy közreműködés magánprojektekben: A Közreműködők biztonsági csoport tagja vagy a projekt megfelelő engedélyei. - Ág- vagy adattárengedélyek beállítása: Az ág vagy adattár engedélyeinek kezelése . – Ágházirendek beállítása, állapotellenőrzések vagy az alapértelmezett ág módosítása: Az adattár vagy ág házirend-engedélyének szerkesztése, illetve a Project Rendszergazdák biztonsági csoport tagsága. - Tároló importálása: A Projekt Adminisztrátorok biztonsági csoport tagja vagy a Git projektszintű Tároló létrehozása engedély beállítása engedély megadása. További információ: Git-adattárengedélyek beállítása. |
| Services | Repók engedélyezve. |
| Eszközök | Opcionális. Parancsok használata: az reposAzure DevOps CLI. |
| Kategória | Követelmények |
|---|---|
| Projekthez való hozzáférés | A projekttagja. |
| Jogosultságok | - Kód megtekintése: Legalább alap szintű hozzáférés. - Klónozás vagy közreműködés a kódban: A Közreműködők biztonsági csoport tagja vagy a projekt megfelelő engedélyei. |
| Services | Repók engedélyezve. |
Mi az a lekéréses kérelemsablon?
A lekéréses kérelmek sablonja egy Markdown-szöveget tartalmazó fájl, amely a lekéréses kérelem létrehozásakor hozzáadódik a lekéréses kérelem leírásához.
Thank you for your contribution to the Fabrikam Fiber repo.
Before submitting this PR, please make sure:
- [ ] Your code builds clean without any errors or warnings
- [ ] You are using approved terminology
- [ ] You have added unit tests
Az Azure Repos a következő típusú lekéréses kérelemsablonok létrehozását teszi lehetővé:
- Alapértelmezett lekéréses kérelemsablon, amelyet a rendszer automatikusan alkalmaz az adattár összes új lekéréses kérésére, kivéve, ha egy ágspecifikus lekéréses kérelemsablon felül van bírálva
- Egy adott ágat megcélzó lekéréses kérelmekre automatikusan alkalmazott ágspecifikus lekéréses kérelemsablonok
- A lekéréses kérelem létrehozója által opcionálisan hozzáadható további lekéréses kérelmek sablonjai
A lekéréses kérelem sablonjának típusát a fájlnév és a mappa helye határozza meg, az alábbi szakaszokban leírtak szerint. A fájlnevek és a mappahelyek nem megkülönböztetik a kis- és nagybetűket, de az adattár alapértelmezett ágában kell lenniük.
Megjegyzés
A lekéréses kérelem sablonfájljainak az adattár alapértelmezett ágában (általában fő) kell lenniük. A rendszer csak az alapértelmezett ágból származó lekéréses kérelemsablonfájlokat használja.
Alapértelmezett lekéréses kérelemsablonok
Új lekéréses kérelem létrehozásakor a rendszer automatikusan alkalmazza az alapértelmezett lekéréses kérelmek sablonjait a leírásmezőre. Ha alapértelmezett lekéréses kérelemsablonnal szeretné konfigurálni az adattárat, hozzon létre egy fájlt, pull_request_template.md vagy pull_request_template.txt mentse azt az adattár alapértelmezett ágába az alábbi mappák egyikében.
- Az adattár gyökérmappájában található mappa
.azuredevops - Az adattár gyökérmappájában található mappa
.vsts - Az adattár gyökérmappájában található mappa
docs - Az adattár gyökérmappája
Több helyen is rugalmasan tárolhatja a lekéréses kérelmek sablonjait. Lekéréses kérelem létrehozásakor az Azure Repos a megadott sorrendben keres a kijelölt mappákban, és az első alapértelmezett lekéréses kérelemsablont használja.
Ha új lekéréses kérelem jön létre az adattárban, hacsak nem alkalmaz egy ágspecifikus lekéréses kérelemsablont , a rendszer az alapértelmezett lekéréses kérelemsablon tartalmát használja a lekéréses kérelem leírásmezőjének előzetes kitöltéséhez.
Igény szerint szerkesztheti vagy hozzáadhatja ezt a leírást, és szükség esetén további lekéréses kérelemsablonokat is hozzáfűzhet, ha kiválasztja őket a Sablon hozzáadása legördülő listából.
Megjegyzés
Ha automatikusan alkalmaz egy alapértelmezett vagy ágspecifikus lekéréses kérelemsablont, az felülírja az alapértelmezett leíráshoz általában használt szabványos véglegesítési üzeneteket. A véglegesítési üzenetek hozzáadása lehetőséget választva visszaadhatja őket.
Ágspecifikus lekéréses kérelemsablonok
Az ágspecifikus lekéréses kérelmek sablonjai konfigurálhatók egy adott ágat megcélzó lekéréses kérelmekhez. Ha úgy szeretné konfigurálni a tárházát, hogy egy ágspecifikus lekérésikérelem-sablont használjon, hozzon létre egy .txt vagy feature.md fájlt, amelynek neve az ág neve, például feature/* a release/october.md ághoz, vagy release/october a release/october/* vagy .md nevű ágakhoz. A név megegyezhet az ágnév első szintjével, például main, dev, release vagy feature, vagy az ágnév több szintjének megfelelő könyvtárakba is ágyazható, mint a(z) release/october/week1 esetében. A rendszer minden egyes ágspecifikus lekéréses kérelemsablont alkalmaz, amikor egy lekéréses kérelem megcélozza az adott ágat vagy az alatta lévő ágakat. A lekéréses kérelem nevű feature.md sablon például akkor lesz alkalmazva, ha egy lekéréses kérelem az feature ágat vagy bármely feature/* ágat célozza. A többszintű ágak legfeljebb 10 szintet támogatnak.
Az ágspecifikus lekéréses kérelmek sablonjait az adattár alapértelmezett ágába kell menteni a következő mappahierarchia használatával: pull_request_template/branches/. Ezeknek a mappáknak az adattár alábbi mappáinak egyikén kell alapulnia.
- Az adattár gyökérmappájában található mappa
.azuredevops - Az adattár gyökérmappájában található mappa
.vsts - Az adattár gyökérmappájában található mappa
docs - Az adattár gyökérmappája
Például egy ágspecifikus lekéréses kérelemsablon, amely az dev ágba irányuló összes lekéréses kérelemre vonatkozik, az alábbi helyek egyikén lesz elnevezve dev.md vagy dev.txt elhelyezve.
<repository root>/.azuredevops/pull_request_template/branches/<repository root>/.vsts/pull_request_template/branches/<repository root>/docs/pull_request_template/branches/<repository root>/pull_request_template/branches/
Az alapértelmezett lekéréses kérelemsablonokhoz hasonlóan több helyen is biztosítunk rugalmasságot az ágspecifikus lekéréses kérelemsablonok tárolásához. A lekéréses kérelem létrehozásakor az Azure Repos egy ágspecifikus lekéréses kérelemsablonhoz megadott sorrendben keresi meg a kijelölt mappákat, és az elsőt használja, amely megfelel az ág nevének. Ha nem található ágspecifikus lekéréses kérelemsablon, az Azure Repos ezután megkeres egy alapértelmezett lekéréses kérelemsablont az előző Alapértelmezett lekéréses kérelemsablonok szakaszban leírtak szerint.
További lekérési kérelem sablonok
Az alapértelmezett és az ágspecifikus lekéréses kérelemsablonok mellett további lekéréses kérelemsablonokat is konfigurálhat. Ezek lehetnek .md vagy .txt fájlok az alapértelmezett ág következő mappáinak egyikében találhatók.
<repository root>/.azuredevops/pull_request_template/<repository root>/.vsts/pull_request_template/<repository root>/docs/pull_request_template/<repository root>/pull_request_template/
Ha létrejön egy lekéréses kérelem, hozzáfűzheti az egyik elérhető lekéréses kérelemsablont a Sablon hozzáadása legördülő listából. A legördülő menüben szereplő nevek a sablonok fájlnevén alapulnak. Vegye figyelembe, hogy előfordulhat, hogy az ágspecifikus sablonok nem jelennek meg ebben a listában.
Az alábbi példában három sablon látható.
-
dev.md– Ez az ágspecifikus sablon, amelyet a rendszer alapértelmezés szerint alkalmazott erre a lekéréses kérelemre a fejlesztői ágba, ahogy azt a fájlnév után megjelenő alapértelmezett üzenet is jelzi. -
additional.md- Ez egy további sablon. -
pull_request_template.md– Ez általában az alapértelmezett sablon, de ebben a pull requestben az ágspecifikus sablondev.mdfelülírta. Annak ellenére, hogy alapértelmezés szerint nem lett hozzáadva, továbbra is alkalmazható a listából való kijelöléssel.
Válassza ki a kívánt további sablon nevét, és fűzze hozzá a tartalmát az aktuális lekéréses kérelem leírásához.
Megjegyzés
A lekérdezéslánchoz fűzve megadhat egy lekéréses kérelemsablont az egyező alapértelmezett vagy ágspecifikus lekéréses kérelmek felülbírálásához ?template=name.md .