Merge pull request #3 from yarcode/beta

Beta

Author: Alexey Samoylov

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - master
+      - main
+      - beta*
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-go@v2
+      with:
+        go-version: '1.18.3'
+
+    - name: Build
+      run: go build .
+
+    - name: Test With Coverage
+      run: go test -race -v -coverprofile=coverage.txt -covermode=atomic ./...
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+
+    - name: Run Vet & Lint
+      run: |
+        go vet ./...

.gitignore

@@ -10,6 +10,7 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+coverage.txt
 
 # Dependency directories (remove the comment below to include it)
 # vendor/

README.md

@@ -1,6 +1,6 @@
 # workerpool
 
-[![codecov](https://codecov.io/gh/yarcode/workerpool/branch/master/graph/badge.svg)](https://codecov.io/gh/yarcode/workerpool)
+[![codecov](https://codecov.io/gh/yarcode/workerpool/branch/main/graph/badge.svg)](https://codecov.io/gh/yarcode/workerpool)
 [![golangci](https://golangci.com/badges/github.com/yarcode/workerpool.svg)](https://golangci.com/r/github.com/yarcode/workerpool)
 [![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/github.com/yarcode/workerpool)
 [![Go Report Card](https://goreportcard.com/badge/github.com/yarcode/workerpool)](https://goreportcard.com/report/github.com/yarcode/workerpool)
@@ -12,6 +12,7 @@ Jobs could have contexts, timeouts, rich retry strategies.
 ## Examples
 
 ```golang
+
 pool := New()
 pool.Start()
 
@@ -21,11 +22,28 @@ job := func(ctx context.Context) error {
 }
 
 pool.Run(job)
-pool.Stop()
+
 ```
 
- Output:
+### AdvancedUsage
+
+```golang
+
+pool := New()
+pool.Start()
+
+job := func(ctx context.Context) error {
+    //
+    // some tricky logic goes here
+    //
+
+    return nil
+}
+// add 3 seconds timeout for a job execution
+job = AddTimeout(job, time.Second*3)
+// retry job execution withing 5 attempts
+job = AddRetry(job, strategy.Limit(5))
+
+pool.Run(job)
 
-```
-hello
 ```

workerpool_test.go

@@ -174,10 +174,12 @@ func ExampleAddLogger() {
 	pool.Start()
 
 	job1 := func(ctx context.Context) error {
+		time.Sleep(5 * time.Millisecond)
 		zerolog.Ctx(ctx).Warn().Msg("hello from job1")
 		return nil
 	}
 	job2 := func(ctx context.Context) error {
+		time.Sleep(10 * time.Millisecond)
 		zerolog.Ctx(ctx).Warn().Msg("hello from job2")
 		return nil
 	}