Automatyzowanie informacji o wersji za pomocą usługi GitHub

  • 5 min

Po zapoznaniu się z tworzeniem i zarządzaniem tagami wydań w repozytorium, dowiesz się, jak skonfigurować automatycznie generowane notatki o wydaniu dla wydań na GitHubie.

Możesz utworzyć omówienie elementów zawartych w wersji, a także dostosować automatyczne informacje o wersji.

Za pomocą etykiet można tworzyć kategorie niestandardowe w celu organizowania wniosków o zmiany. Możesz również uwzględnić lub wykluczyć określone etykiety i użytkowników z danych wyjściowych.

Tworzenie automatycznie generowanych notatek wydania

Podczas konfigurowania wydania masz opcję "Automatyczne generowanie informacji o wersji", aby uwzględnić wszystkie zmiany między tagiem a ostatnią wersją. Jeśli nigdy wcześniej nie utworzyłeś wydania, zawiera ono wszystkie zmiany z twojego repozytorium.

Zrzut ekranu przedstawiający sposób tworzenia informacji o wersji z usługi GitHub.

Możesz go dostosować lub pozostawić tak, jak jest.

Konfigurowanie automatycznie generowanego szablonu notatek wydania

Możesz dostosować automatycznie wygenerowany szablon informacji o wersji, wykonując następujące kroki:

  1. Przejdź do repozytorium i utwórz nowy plik.

    Zrzut ekranu przedstawiający sposób tworzenia nowego pliku w usłudze GitHub.

  2. Użyj nazwy .github/release.yml , aby utworzyć plik release.yml w katalogu .github .

    Zrzut ekranu przedstawiający sposób tworzenia pliku release.yml w usłudze GitHub.

  3. Zapisz w formacie YAML, który ściąga etykiety żądań i autorów, których chcesz wykluczyć z tej wersji. Możesz również utworzyć nowe kategorie i wyświetlić listę etykiet pull requestów w każdej z nich. Aby uzyskać więcej informacji na temat opcji konfiguracji, zobacz Automatycznie wygenerowane informacje o wersji — GitHub Docs.

    Przykładowa konfiguracja:

    # .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. Zatwierdź nowy plik.

    Zrzut ekranu przedstawiający sposób zatwierdzania nowego pliku w usłudze GitHub.

  5. Spróbuj utworzyć nową wersję i wybierz pozycję + Automatyczne generowanie informacji o wersji , aby zobaczyć, jak działa szablon.

Aby uzyskać więcej informacji, zobacz: