Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Improve documentation for nested do tasks and multiple workflows

Aperta Adatta ai principianti
  • Qualcosa non va?
#584 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
Mezza giornata
Idoneità per principianti
74/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go
Ambito
documentation

Direzione di ricerca

Inizia leggendo examples/multiple-workflows e la discussione in #582 per comprendere il confine documentato dei workflow e il pattern condizionale supportato. Aggiorna la documentazione pertinente per spiegare le do tasks annidate e di primo livello, distinguerle dalla composizione sequenziale inline, aggiungere un collegamento incrociato all’esempio e chiarire la formulazione del messaggio di debug. Il lavoro è completato quando un lettore può capire quando viene definito un workflow Temporal separato e come mantenere la validazione in un’unica esecuzione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

Improve the documentation around nested do tasks so it is clear when Zigflow treats them as separate Temporal workflow definitions rather than inline task groups.

This came up in discussion #582, where a user expected a nested do block to execute inline as part of the current workflow. In Zigflow, nested do tasks are intentionally used to define additional workflows and are therefore not executed inline in the parent workflow.

What should be documented

  • Explain that nested/top-level do tasks can define separately registered Temporal workflows.

  • Explain that these workflow definitions are not executed inline as part of the surrounding workflow.

  • Clarify how this differs from ordinary sequential task composition.

  • Show the supported pattern for conditional validation and error handling within a single Temporal Workflow Execution, without introducing another workflow definition.

  • Cross-link to examples/multiple-workflows.

  • Consider improving the wording around the existing debug message:

    Nested do task detected - ignoring

    Ignoring can imply that the block is simply discarded rather than treated as another workflow definition.

Motivation

The current behaviour is intentional, but it is not obvious from the workflow YAML alone.

A user can reasonably read do as an inline grouping construct, particularly when it appears among ordinary workflow tasks. The documentation should make the resulting Temporal workflow boundary explicit and provide an obvious alternative for users who want to group conditional logic without creating another workflow.

Lingua principale
Go
Stelle
209
Fork
27
Merge medio
6h 35m
PR unite (30g)
30

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di zigflow/zigflow

Tutte le issue di zigflow/zigflow

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.