Automatizace poznámek k vydání verze pomocí GitHubu

  • 5 min

Jakmile se naučíte vytvářet a spravovat značky vydaných verzí ve vašem úložišti, dozvíte se, jak nakonfigurovat automaticky vygenerovanou šablonu zpráv k vydání verze z vašich verzí GitHubu.

Můžete vygenerovat přehled obsahu verze a také si můžete přizpůsobit své automatizované poznámky k verzi.

Pomocí popisků můžete vytvořit vlastní kategorie pro uspořádání žádostí o přijetí změn, které chcete zahrnout nebo vyloučit, aby se ve výstupu zobrazovaly konkrétní popisky a uživatelé.

Vytváření automaticky generovaných zpráv k vydání verze

Při konfiguraci vydané verze se zobrazí možnost Automaticky vygenerovat poznámky k verzi, která zahrnuje všechny změny mezi značkou a poslední verzí. Pokud jste nikdy nevytvořili verzi, skládá se ze všech změn z vašeho úložiště.

Snímek obrazovky znázorňuje, jak vytvořit poznámky k verzi z GitHubu

Můžete zvolit, jestli ho chcete přizpůsobit, nebo ho nechat tak, jak je.

Konfigurace automaticky vygenerované šablony zpráv k vydání verze

Šablonu poznámek k verzi pro automatické generování si můžete přizpůsobit pomocí následujícího postupu.

  1. Přejděte do úložiště a vytvořte nový soubor.

    Snímek obrazovky znázorňuje, jak vytvořit nový soubor na GitHubu

  2. K vytvoření souboru release.yml v adresáři .github můžete použít název .github/release.yml.

    Snímek obrazovky znázorňuje, jak vytvořit soubor release.yml na GitHubu.

  3. V YAML zadejte popisky žádostí o přijetí změn a autoři, které chcete z této verze vyloučit. Můžete také vytvořit nové kategorie a vypsat popisky žádostí o přijetí změn v každé z nich. Další informace o možnostech konfigurace najdete v tématu Automaticky generované poznámky k verzi – Dokumentace GitHubu.

    Příklad konfigurace:

    # .github/release.yml

changelog:
  exclude:
    labels:
    - ignore-for-release
    authors:
    - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - Semver-Major
        - breaking-change
    - title: Exciting New Features 🎉
      labels:
        - Semver-Minor
        - enhancement
    - title: Other Changes
      labels:
        - *

  4. Potvrďte nový soubor.

    Snímek obrazovky s potvrzením nového souboru na GitHubu

  5. Zkuste vytvořit novou verzi a kliknutím na + automaticky vygenerovat poznámky k verzi zobrazte strukturu šablony.

Další informace naleznete v tématu: