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

  • 5 min

Jakmile se naučíte vytvářet a spravovat release tagy ve vašem úložišti, dozvíte se, jak nakonfigurovat automaticky generovanou šablonu poznámek k vydání z vašich GitHub vydání.

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

Pomocí popisků je možné vytvořit vlastní kategorie pro uspořádání žádostí o přijetí změn, přičemž můžete zahrnout nebo vyloučit specifické popisky a uživatele ze zobrazování ve výstupu.

Vytváření automaticky generovaných poznámek k vydání

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 s návodem, jak vytvořit poznámky k vydání z GitHubu.

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

Konfigurace šablony automaticky generovaných poznámek k vydání

Šablonu poznámek k automaticky generované verzi si můžete přizpůsobit podle těchto kroků.

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

    Snímek obrazovky, jak vytvořit nový soubor na GitHubu

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

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

  3. V YAML zadejte popisky a autory žádostí o stahování, které chcete z této verze vyloučit. Můžete také vytvořit nové kategorie a vypsat štítky žá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, jak přidat nový soubor na GitHub

  5. Zkuste vytvořit novou verzi a klikněte na + automaticky generované poznámky k verzi, abyste zobrazili strukturu šablony.

Další informace najdete tady: