Vést plán jako milníky a úkoly, které nástroj umí validovat

setup: plan-model
given:
  - 'a canonical project model with one milestone and two issues, the second depending on the first'
steps:
  - id: validate
    run: ['plan', 'validate']
    note: 'every record parses, every reference resolves, the dependency graph is acyclic'
    expect:
      exit: 0
      stdout_contains: ['milestone', 'issue', '0 failure']
  - id: what-is-ready
    run: ['plan', 'ready']
    note: 'the issues nothing blocks'
    expect:
      exit: 0
      stdout_contains: ['I0001']
  - id: what-is-blocked
    run: ['plan', 'blocked']
    note: 'the issues waiting on another'
    expect:
      exit: 0
      stdout_contains: ['I0002']
then:
  - 'status is derived from the records and git, never written into them'
  - 'an issue cannot be marked done without the evidence its milestone requires'

Scénář

Provedeno proti skutečnému nástroji v repozitáři připraveném pomocí plan-model, při každém generování tohoto webu. To, co následuje, není popis toho, co by se mělo stát; je to to, co se stalo.

Co nástroj udělal

Důkaz běhu, z něhož byla tato stránka vygenerována: pass, 3 kroky. Výstup je normalizován: cesta k repozitáři, časová razítka, id a doby trvání jsou zástupné hodnoty; nic dalšího se neupravuje.

Testováno v test/cases/94_use_cases.sh, který spouští každý scénář a odmítne krok, jehož zaznamenaný výstup není tím, co vyprodukoval.

1. 1$ majordomus plan validate exit 0

   každý záznam se zparsuje, každá reference se rozřeší, graf závislostí je acyklický

   plan validate: 1 milestone(s), 2 issue(s), 0 failure(s), 0 warning(s)

   • exit 0
   • stdout_contains /milestone/
   • stdout_contains /issue/
   • stdout_contains /0 failure/
2. 2$ majordomus plan ready exit 0

   úkoly, které nic neblokuje

   I0001   w0   Issue I0001
       scope: src/I0001

   • exit 0
   • stdout_contains /I0001/
3. 3$ majordomus plan blocked exit 0

   úkoly čekající na jiný

   I0002   w1   Issue I0002
       waiting on: I0001

   • exit 0
   • stdout_contains /I0002/

Proč to nástroj ví

Řetězec od této stránky ke kódu: případ užití jmenuje příkazy, pravidla a tvrzení; každé pravidlo se dispatchuje z registru a každé tvrzení jmenuje test, který ho dokazuje; scénář výše provedl příkazy. Nic v tomto řetězci není text o záměru.

• majordomus planModel milníků a úkolů — ověřte ho, čtěte ho a proveďte jím jeden úkol.

Pravidla, díky nimž platí

• ✕blokující Integrita modelu projektuKaždý soubor milníku a úkolu jde naparsovat, nese id, které tvrdí jeho název souboru, a neobsahuje klíč, který nikdo nečte.
• ✕blokující Integrita grafu závislostíGraf závislostí úkolů je acyklický, každá hrana jmenuje existující úkol a žádný úkol se neprovádí před závislostí, která není hotová.

Uplatněné záruky

• ○zaručeno Milníky a úkoly jsou kanonické soubory repozitáře a klíč, který nikdo nečte, je chyba
• ○zaručeno Stav úkolu a milníku se odvozuje ze zaznamenaných faktů a nikde se neukládá
• ○zaručeno Cyklus, samozávislost a závislost na úkolu, který neexistuje, jsou každé odmítnuty jménem
• ○zaručeno Vlny provádění se počítají z grafu a úkoly v jedné vlně, které zasahují do stejných cest, se hlásí jako serializované

Související případy užití

Vypočteno z toho, co sdílejí: tvrzení, pravidla, příkazy, kategorie, aplikace. Tento seznam nikdo neudržuje.

• Dodávejte úkoly ve vlnách, které graf spočítá, a berte dalšíOvěřte plán, přečtěte si vlny provádění, které z grafu závislostí plynou, podívejte se, které úkoly jsou připravené a které na co čekají, a vezměte ten jeden úkol, který má worker dělat teď.
• Dokončit úkol, jen když existují jeho důkazySledujte, jak úkol odmítne dokončení, dokud chybí požadovaný důkaz, přečtěte si plán rozvoje odvozený ze stavu milníků a nechte projekci na GitHub projekcí.
• Rozhodnout, zda je dokončená práce skutečně dokončenáVyhodnoťte kontrakt řádek po řádku, místo abyste přijali větu, která tvrdí, že je práce hotová.
• Zablokovat přijetí kvůli otázce, na kterou nikdo neodpovědělOtevřete k úloze otázku, sledujte, jak finish odmítá dokončení, dokud je nevyřešená, vyřešte ji odpovědí a teprve pak úlohu dokončete.
• Přečíst si, co se stalo, a držet ledger v mezíchPřečte ledger jen pro připojování jako provozní historii, filtrovanou podle úlohy a události, zvaliduje každý řádek a nejstarší řádky přesune do archivu místo smazání.

Okamžiky, na které to odpovídá

• → přečetl tři plány rozvoje jednoho projektu a nevěřil žádnému Plán vedený v próze je snímek a každá jeho kopie se rozchází svým tempem; uložený stav je tvrzení, které platí i poté, co se svět pohnul.
• → našel podstatnou změnu, kterou nikdy nepožadoval žádný úkol, ticket ani plán Práce přichází bez vymezeného kontraktu, takže její rozsah, kritéria přijetí i vlastnictví se rozhodují až zpětně.
• → uzavřel úkol, jehož kritéria přijetí nikdo skutečně neověřil Dokončení se eviduje jako změna stavu v trackeru, a ne jako důkaz v repozitáři, takže se obojí okamžitě rozejde.
• → se zeptal, kam milník dospěl, a musel se jít ptát čtyř lidí Pokrok je agregát, který existuje jen v lidech, protože části, které agreguje, se nikdy nezaznamenaly ve tvaru, který by šel sečíst.