Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hatchet-quickstarts

This repository owns the hatchet quickstart CLI templates and the generated examples.

Template layout

Templates live under templates/, are embedded into the module, and are returned by TemplatesFS(). The Hatchet CLI templater reads fixed paths from this tree, so the layout is a contract rather than an internal detail.

The default simple quickstart lives at the language root:

  • templates/go/ for Go.
  • templates/<language>/shared/ plus templates/<language>/<package-manager>/ for Python and TypeScript, where the package-manager directory is overlaid on shared.

The main repo templater hardcodes these templates/<language>/... paths, so the default templates must not move while released CLI versions depend on them. Use-case templates therefore go under a separate subtree that mirrors the same structure one level down:

  • templates/use-cases/<use-case>/go/
  • templates/use-cases/<use-case>/<language>/shared/ plus templates/use-cases/<use-case>/<language>/<package-manager>/

This keeps the default quickstart untouched, avoids collisions with language directory names, and lets a future --use-case path builder reuse the existing overlay of shared and package-manager directories with a different root.

The first use case is scheduled, with templates for Go, Python, and TypeScript under templates/use-cases/scheduled/ and generated examples under examples/use-cases/scheduled/. Each language registers a cron schedule with its SDK (WithWorkflowCron in Go, on_crons in Python, the on cron option in TypeScript) and defines a manual-run trigger for on-demand runs. The --use-case flag itself lives in the main Hatchet CLI.

About

No description, website, or topics provided.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages