Jak udržujete v týmu changelog? rubrika: Nástroje: Verzování

4 joska
položil/-a 5.8.2016

Ahoj,

řeším, jak zefektivnit práci s projektovými changelogy. Aktuálně řešíme changelogy tak, že se při realeases ručně vypíší branches, které byly mergnuty do dev od posledního release a ručně se k nim doplní názvy issues (branches odpovídají taskům v issue trackeru), které se tím řešily případně se doplní poznámky o BC break změnách. Funguje to, ale slabá místa tohoto přístupu jsou jasná na první pohled.

Řešíme proto, jak udržovat changelogy průběžně. Asi nejrozumnější, co jsem našel, je mít v changelogu sekci "Unreleased" nahoře a mít v týmu pravidlo, že je povinnost upravit changelog v každém PR tak, jak to popisuje https://github.com/olivierlacan/keep-a-changelog. Při release se pak už jen přesune obsah unreleased do aktuální verze.

Máte někdo vyzkoušenou lepší praxi udržby projektových changelogů?

Díky.

odkaz Vyřešeno
6 kluvi
odpověděl/-a 8.8.2016

A proc to neresite v tom issue trackeru? K issues priradit cislo releasu a brat to odtud. Potom musi byt pravidlo, ze uz jednou uzavrene issues se neoteviraji (aby nebyla issue ve vic verzich). My na to pouzivame JIRA+Bitbucket a spokojenost. Branche a issues jsou provazany, takze rovnou vidim co se upravovalo,...

Komentáře

  • joska : Wow, protože nás to nenapadlo :D Díky. Jak pak řešíte detekci BC breaků napříč jednotlivými releasy? — 8.8.2016
  • kodl : JJ, Atlassian stack je v tomhle perfektni, vsechno provazane, pripravene... — 8.8.2016
  • kluvi : @joska: popravdě neřešíme... vyvíjíme jednu aplikaci, která je pouze na našich serverech. K ní se dělají uživatelské úpravy. Tam má každý projekt vlastní repozitář a ty úpravy jsou tam tak malé, že ani neděláme pull-requesty... tj changelog je prakticky historie v GITu. BC breaky v tomto případě možné jsou, nicméně prakticky se neobjevují (záleží na rozsáhlosti dané úpravy). Pokud by některý z těchto projektů přerostl, zavedou se stejná pravidla jako pro vývoj hlavního produktu. Jinak JIRA umí generovat i "Release notes" (je to takový malý nenápadný odkaz v detailu releasu) - tj vygeneruje to v podstatě seznam issues s jejich krátkým popiskem buď v plaintextu nebo do HTML. Určitě by to šlo i nějak automatizovat. — 9.8.2016

Pro plný přístup na Devel.cz se prosím přihlaste:

Rychlé přihlášení přes sociální sítě:

Nebo se přihlaste jménem a heslem:

Zadejte prosím svou e-mailovou adresu.
Zadejte své heslo.

Aktuální otázky v rubrice Nástroje: Verzování

Otázky uživatele joska