diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000..3582a4c --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1,7 @@ +# https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples +issues=false +unreleased=false +usernames-as-github-logins=true +since-tag=v0.1.0 +user=pancsta +project=asyncmachine-go \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a54fe91 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +## [v0.2.0](https://github.com/pancsta/asyncmachine-go/tree/v0.2.0) (2024-01-18) + +[Full Changelog](https://github.com/pancsta/asyncmachine-go/compare/v0.1.0...v0.2.0) + +**Merged pull requests:** + +- chore: fix readme playground links [\#8](https://github.com/pancsta/asyncmachine-go/pull/8) (@pancsta) +- feat: synchronous emitter bindings [\#7](https://github.com/pancsta/asyncmachine-go/pull/7) (@pancsta) +- fix: synchronous GetStateCtx, When, WhenNot [\#6](https://github.com/pancsta/asyncmachine-go/pull/6) (@pancsta) diff --git a/README.md b/README.md index d6b3df2..e70b855 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ func main() { ## Examples - [Expense Workflow](/examples/temporal-expense/expense_test.go) \| - [Temporal version](https://github.com/temporalio/samples-go/blob/main/expense/) \| [Go playground](https://play.golang.com/p/CqHX5dR7r_H) + [Temporal version](https://github.com/temporalio/samples-go/blob/main/expense/) \| [Go playground](https://play.golang.com/p/P1eg6tKh6E4) ```go am.States{ @@ -70,7 +70,7 @@ am.States{ ``` - [FileProcessing workflow](/examples/temporal-fileprocessing/fileprocessing.go) \| - [Temporal version](https://github.com/temporalio/samples-go/blob/main/fileprocessing/) \| [Go playground](https://play.golang.com/p/TXMpqGFKUvM) + [Temporal version](https://github.com/temporalio/samples-go/blob/main/fileprocessing/) \| [Go playground](https://play.golang.com/p/Fv92Xpzlzv6) ```go am.States{ @@ -137,6 +137,10 @@ func HandleFileProcessingTask(ctx context.Context, t *asynq.Task) error { - [Relations](/docs/manual.md#relations) - [Queue](/docs/manual.md#queue) +## Changelog + +Latest release: `v0.2.0`. See [CHANELOG.md](/CHANGELOG.md) for details. + ## Status **Beta** - although the ideas behind AsyncMachine have been proven to work, the golang implementation is fairly fresh @@ -145,4 +149,4 @@ and may suffer from bugs, memory leaks, race conditions and even panics. ## TODO -FUT [issues](https://github.com/pancsta/asyncmachine-go/issues). +See [issues](https://github.com/pancsta/asyncmachine-go/issues). diff --git a/Taskfile.yml b/Taskfile.yml index f59bbd0..1082dcb 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -62,10 +62,17 @@ tasks: # TODO -g - mdl -c .mdlrc . + changelog: + cmds: +# - github_changelog_generator + - head -n -4 CHANGELOG.md > CHANGELOG-tmp.md + - mv CHANGELOG-tmp.md CHANGELOG.md + install-deps: cmds: - go mod tidy - curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.55.2 - go install mvdan.cc/gofumpt@latest - go install golang.org/x/tools/cmd/goimports@latest - - gem install mdl \ No newline at end of file + - gem install mdl + - gem install github_changelog_generator \ No newline at end of file diff --git a/examples/temporal-expense/expense_test.go b/examples/temporal-expense/expense_test.go index 3583514..ee664a5 100644 --- a/examples/temporal-expense/expense_test.go +++ b/examples/temporal-expense/expense_test.go @@ -1,6 +1,6 @@ // Based on https://github.com/temporalio/samples-go/blob/main/expense/ // -// Go playgroundL https://goplay.tools/snippet/KAxlf3gm7pH +// Go playgroundL https://play.golang.com/p/P1eg6tKh6E4 // // This example shows a simple payment workflow with an async approval input, // going from CreatingExpense to PaymentCompleted. @@ -230,7 +230,7 @@ func ExpenseFlow( log(msg, args...) }) - // bind handlers and wait for Ready + // bind handlers err := machine.BindHandlers(&MachineHandlers{}) if err != nil { return machine, err diff --git a/examples/temporal-fileprocessing/fileprocessing.go b/examples/temporal-fileprocessing/fileprocessing.go index c42e929..fe71b55 100644 --- a/examples/temporal-fileprocessing/fileprocessing.go +++ b/examples/temporal-fileprocessing/fileprocessing.go @@ -1,6 +1,6 @@ // Based on https://github.com/temporalio/samples-go/blob/main/fileprocessing/ // -// Go playground: https://goplay.tools/snippet/aTo4hsyJZck +// Go playground: https://play.golang.com/p/Fv92Xpzlzv6 // // This example shows a simple file processing workflow going from // DownloadingFile to FileUploaded. @@ -224,7 +224,7 @@ func FileProcessingFlow(ctx context.Context, log Logger, filename string) (*am.M log(msg, args...) }) - // bind handlers and wait for Ready + // bind handlers err := machine.BindHandlers(&MachineHandlers{}) if err != nil { return machine, err