Skip to content

Commit

Permalink
Fix README.md and lint errors (#74)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexshtin committed Mar 23, 2020
1 parent b46ce50 commit ea11a06
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 19 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Developing temporal-sdk
# Developing Temporal Go SDK

This doc is intended for contributors to `temporal-client` (hopefully that's you!)
This doc is intended for contributors to `temporal-go-sdk` (hopefully that's you!)

**Note:** All contributors also need to fill out the [Temporal Contributor License Agreement](https://gist.github.com/samarabbas/7dcd41eb1d847e12263cc961ccfdb197) before we can merge in any of your changes

Expand All @@ -10,12 +10,11 @@ This doc is intended for contributors to `temporal-client` (hopefully that's you

## Checking out the code

Make sure the repository is cloned to the correct location:
Make sure the repository is cloned to the preferred location:
(Note: the path is `go.temporal.io/temporal/` instead of github repo)

```bash
go get go.temporal.io/temporal/...
cd $GOPATH/src/go.temporal.io/temporal
```

## Licence headers
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

[Temporal](https://github.com/temporalio/temporal) is a distributed, scalable, durable, and highly available orchestration engine used to execute asynchronous long-running business logic in a scalable and resilient way.

`temporal-client` is the framework for authoring workflows and activities.
`temporal-go-sdk` is the framework for authoring workflows and activities using Go language.

## How to use

Make sure you clone this repo into the correct location.
Clone this repo into the preferred location.

```bash
git clone [email protected]:temporalio/temporal-go-client.git $GOPATH/src/go.temporal.io/temporal
git clone [email protected]:temporalio/temporal-go-sdk.git
```

or
Expand All @@ -20,11 +20,11 @@ go get go.temporal.io/temporal

See [samples](https://github.com/temporalio/temporal-go-samples) to get started.

Documentation is available [here](https://cadenceworkflow.io/docs/07_goclient/).
Documentation is available [here](https://docs.temporal.io/docs/07_goclient/).
You can also find the API documentation [here](https://godoc.org/go.temporal.io/temporal).

## Contributing
We'd love your help in making the Temporal Go client great. Please review our [contribution guidelines](CONTRIBUTING.md).
We'd love your help in making the Temporal Go SDK great. Please review our [contribution guidelines](CONTRIBUTING.md).

## License
MIT License, please see [LICENSE](LICENSE) for details.
Expand Down
5 changes: 3 additions & 2 deletions internal/interceptors.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@
package internal

import (
"github.com/uber-go/tally"
"time"

"github.com/uber-go/tally"
"go.uber.org/zap"
)
import "go.uber.org/zap"

// WorkflowInterceptorFactory is used to create a single link in the interceptor chain
type WorkflowInterceptorFactory interface {
Expand Down
4 changes: 2 additions & 2 deletions internal/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ type (
TaskListActivitiesPerSecond float64

// Optional: Sets the maximum number of goroutines that will concurrently poll the
// cadence-server to retrieve activity tasks. Changing this value will affect the
// temporal-server to retrieve activity tasks. Changing this value will affect the
// rate at which the worker is able to consume tasks from a task list.
// default: 2
MaxConcurrentActivityTaskPollers int
Expand All @@ -88,7 +88,7 @@ type (
WorkerDecisionTasksPerSecond float64

// Optional: Sets the maximum number of goroutines that will concurrently poll the
// cadence-server to retrieve decision tasks. Changing this value will affect the
// temporal-server to retrieve decision tasks. Changing this value will affect the
// rate at which the worker is able to consume tasks from a task list.
// default: 2
MaxConcurrentDecisionTaskPollers int
Expand Down
7 changes: 1 addition & 6 deletions test/workflow_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -422,12 +422,7 @@ func (w *Workflows) ConsistentQueryWorkflow(ctx workflow.Context, delay time.Dur
ScheduleToCloseTimeout: 5 * time.Second,
})

workflowInfo := internal.GetWorkflowInfo(laCtx)
if &workflowInfo.WorkflowType == nil {
return errors.New("failed to get work flow type")
}

workflow.ExecuteLocalActivity(laCtx, LocalSleep, delay).Get(laCtx, nil)
_ = workflow.ExecuteLocalActivity(laCtx, LocalSleep, delay).Get(laCtx, nil)
queryResult = signalData
return nil
}
Expand Down

0 comments on commit ea11a06

Please sign in to comment.