Automatyzowanie informacji o wersji za pomocą usługi GitHub

  • 5 min

Po zapoznaniu się ze sposobem tworzenia i zarządzania tagami wydań w repozytorium, dowiesz się, jak skonfigurować automatycznie generowany szablon notatek o wydaniu z wydań GitHub.

Możesz wygenerować omówienie zawartości wydania, a także dostosować zautomatyzowane notatki o wydaniu.

Za pomocą etykiet można tworzyć niestandardowe kategorie do organizowania żądań ściągnięcia, przy czym można uwzględniać lub wykluczać określone etykiety i użytkowników z pojawiania się w danych wyjściowych.

Tworzenie automatycznie generowanych notatek wydania

Podczas konfigurowania wersji zostanie wyświetlona opcja Automatycznie generuj informacje o wersji, aby uwzględnić wszystkie zmiany między tagiem a ostatnią wersją. Jeśli nigdy nie utworzyłeś wydania, składa się ono ze wszystkich zmian z twojego repozytorium.

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

Możesz wybrać, czy chcesz ją dostosować, czy pozostawić ją tak, jak jest.

Konfigurowanie automatycznie generowanego szablonu notatek o wydaniu

Szablon informacji o wersji można dostosować automatycznie, 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. Możesz użyć 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. Określ w YAML etykiety żądań ściągnięcia oraz 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 generowane 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 kliknij pozycję + Automatyczne generowanie informacji o wersji, aby wyświetlić strukturę szablonu.

Aby uzyskać więcej informacji, zobacz: