Vylepšení popisů žádostí o přijetí změn pomocí šablon

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Psaní správných popisů žádostí o přijetí změn je skvělý způsob, jak revidujícím pomoct zjistit, co mají při kontrole kódu očekávat. Představují také skvělý způsob, jak sledovat, co je potřeba udělat při každé změně, jako je testování, přidání testů jednotek a aktualizace dokumentace. Šablony žádostí o přijetí změn můžou vývojářům pomoct vytvářet skvělé popisy žádostí o přijetí změn, které splňují standardy vaší organizace.

V tomto článku se dozvíte, jak začít používat šablony žádostí o přijetí změn.

Poznámka

Šablony žádostí o přijetí změn můžou poskytovat pokyny, ale jsou jenom rady. Zásady pro větev použijte k vynucování osvědčených postupů, jako je vyžadování žádostí o přijetí změn pro klíčové větve, jako je main, vyžadování úspěšného sestavení a vynucení požadovaných kontrolorů. Další informace najdete v tématu Zásady větví.

Co je šablona žádosti o přijetí změn?

Šablona žádosti o přijetí změn je soubor obsahující text Markdownu , který se přidá do popisu žádosti o přijetí změn při vytvoření žádosti o přijetí změn.

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

Azure Repos umožňuje vytvořit následující typ šablon žádostí o přijetí změn:

• Výchozí šablona žádosti o přijetí změn, která se automaticky použije pro všechny nové žádosti o přijetí změn v úložišti, pokud ji nepřepíše šablona žádostí o přijetí změn pro konkrétní větev.
• Šablony žádostí o přijetí změn pro konkrétní větev, které se automaticky použijí u žádostí o přijetí změn, jejichž cílem je konkrétní větev
• Další šablony žádostí o přijetí změn, které může tvůrce žádostí o přijetí změn volitelně přidat

Typ šablony žádosti o přijetí změn je určen názvem souboru a umístěním složky, jak je popsáno v následujících částech. Názvy souborů a umístění složek nerozlišují velká a malá písmena, ale musí být ve výchozí větvi úložiště.

Poznámka

Všechny soubory šablony žádostí o přijetí změn musí být umístěné ve výchozí větvi (obvykle main) vašeho úložiště. Použijí se jenom soubory šablony žádostí o přijetí změn z výchozí větve.

Výchozí šablony žádostí o přijetí změn

Výchozí šablony žádostí o přijetí změn se automaticky použijí na pole popisu při vytvoření nové žádosti o přijetí změn. Pokud chcete v úložišti nakonfigurovat výchozí šablonu žádosti o přijetí změn, vytvořte soubor s názvem pull_request_template.md nebo pull_request_template.txt a uložte ho do výchozí větve úložiště v jedné z následujících složek.

• Složka s názvem .azuredevops , která je obsažená v kořenové složce úložiště
• Složka s názvem .vsts , která je obsažená v kořenové složce úložiště
• Složka s názvem docs , která je obsažená v kořenové složce úložiště
• Kořenová složka úložiště

K dispozici je více umístění, abyste měli flexibilitu při ukládání šablon žádostí o přijetí změn. Při vytvoření žádosti o přijetí změn Azure Repos prohledá určené složky v daném pořadí a použije první nalezenou výchozí šablonu žádosti o přijetí změn.

Při vytvoření nové žádosti o přijetí změn v úložišti se obsah výchozí šablony žádosti o přijetí změn použije k předběžnému vyplnění pole popisu v žádosti o přijetí změn, pokud se nepoužije šablona žádosti o přijetí změn pro konkrétní větev .

Tento popis můžete upravit nebo přidat do tohoto popisu a v případě potřeby přidat další šablony žádostí o přijetí změn tak, že je vyberete z rozevíracího seznamu Přidat šablonu .

Poznámka

Když se automaticky použije výchozí šablona žádosti o přijetí změn nebo pro konkrétní větev, nahradí standardní zprávy potvrzení, které se obvykle používají pro výchozí popis. Můžete je přidat zpět výběrem možnosti Přidat zprávy potvrzení.

Šablony žádostí o přijetí změn pro konkrétní větev

Pro žádosti o přijetí změn, které cílí na konkrétní větev, je možné nakonfigurovat šablony žádostí o přijetí změn pro konkrétní větev. Pokud chcete nakonfigurovat úložiště pomocí šablony žádosti o přijetí změn pro konkrétní větev, vytvořte .txt soubor nebo .md s názvem podle vaší větve. Název se musí shodovat s první úrovní názvu větve, například main, dev, releasenebo feature. Každá šablona žádosti o přijetí změn pro konkrétní větev se použije vždy, když žádost o přijetí změn cílí na danou větev nebo větve, které jsou v ní obsažené. Například šablona žádosti o přijetí změn s názvem feature.md by se použila, pokud by žádost o přijetí změn cílila na feature větev nebo na některou z větví feature/* .

Šablony žádostí o přijetí změn specifické pro větev musí být uložené ve výchozí větvi úložiště pomocí následující hierarchie složek: pull_request_template/branches/. Tyto složky musí být založené na jedné z následujících složek ve vašem úložišti.

• Složka s názvem .azuredevops , která je obsažená v kořenové složce úložiště
• Složka s názvem .vsts , která je obsažená v kořenové složce úložiště
• Složka s názvem docs , která je obsažená v kořenové složce úložiště
• Kořenová složka úložiště

Například šablona žádosti o přijetí změn specifická pro danou větev, která by se měla vztahovat na všechny žádosti o přijetí změn do dev větve, by měla název dev.md nebo dev.txt a umístěná v jednom z následujících umístění.

• <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/

Stejně jako výchozí šablony žádostí o přijetí změn je k dispozici více umístění, která poskytují flexibilitu při ukládání šablon žádostí o přijetí změn pro konkrétní větev. Při vytvoření žádosti o přijetí změn Azure Repos vyhledá v určených složkách v uvedeném pořadí šablonu žádosti o přijetí změn pro konkrétní větev a použije první, kterou najde a která odpovídá názvu větve. Pokud se nenajde žádná šablona žádosti o přijetí změn pro konkrétní větev, Azure Repos pak vyhledá výchozí šablonu žádosti o přijetí změn, jak je popsáno v předchozí části Výchozí šablony žádostí o přijetí změn.

Další šablony žádostí o přijetí změn

Kromě výchozích šablon žádostí o přijetí změn a pro konkrétní větev můžete nakonfigurovat další šablony žádostí o přijetí změn. Může se jednat .md o soubory nebo .txt umístěné v jedné z následujících složek ve vaší výchozí větvi.

• <repository root>/.azuredevops/pull_request_template/
• <repository root>/.vsts/pull_request_template/
• <repository root>/docs/pull_request_template/
• <repository root>/pull_request_template/

Při vytvoření žádosti o přijetí změn můžete připojit libovolnou z dostupných šablon žádostí o přijetí změn tak, že je vyberete z rozevíracího seznamu Přidat šablonu . Názvy v rozevíracím seznamu jsou založené na názvech souborů šablon.

V následujícím příkladu jsou uvedeny tři šablony.

• dev.md – Jedná se o šablonu pro konkrétní větev, která se ve výchozím nastavení použila pro tuto žádost o přijetí změn do větve dev, jak je uvedeno ve výchozí zprávě uvedené za názvem souboru.
• additional.md - Toto je další šablona.
• pull_request_template.md – Obvykle se jedná o výchozí šablonu, ale v této žádosti o přijetí změn ji přepsala dev.md šablona pro konkrétní větev. I když nebyl ve výchozím nastavení přidán, můžete ho použít tak, že ho vyberete ze seznamu.

Vyberte název požadované další šablony a připojte její obsah k aktuálnímu popisu žádosti o přijetí změn.

Poznámka

Zadáním šablony žádosti o přijetí změn můžete přepsat jakoukoli odpovídající výchozí nebo větev specifické žádosti o přijetí změn připojením ?template=name.md k řetězci dotazu.

Viz také

• Vytvoření žádosti o přijetí změn ke kontrole a sloučení kódu
• Informace o větvích a zásadách větví