Skip to content

Commit

Permalink
chore: Update doc about Go package
Browse files Browse the repository at this point in the history
  • Loading branch information
lym953 committed Feb 21, 2025
1 parent 93dbd50 commit 3574ed5
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ datadogLambda.addForwarderToNonLambdaLogGroups([<LOG_GROUPS>])

```go
import (
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct"
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct/v2"
)
datadogLambda := ddcdkconstruct.NewDatadogLambda(
stack,
Expand Down Expand Up @@ -507,7 +507,7 @@ Example stack: [step-functions-go-stack](https://github.com/DataDog/datadog-cdk-

```
import (
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct"
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct/v2"
"github.com/aws/aws-cdk-go/awscdk/v2"
sfn "github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions"
)
Expand All @@ -534,7 +534,7 @@ To merge the Step Function's traces with downstream Lambda function or Step func

```
import (
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct"
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awslambda"
sfn "github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions"
sfntasks "github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks"
Expand Down Expand Up @@ -659,6 +659,18 @@ In February 2025, Datadog released a major version update from `1.x.x` to `2.x.x

2. Upgrade Node.js version to `18.18.0` or above.

3. For Go, change the import from:

```
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct"
```

to:

```
"github.com/DataDog/datadog-cdk-constructs-go/ddcdkconstruct/v2"
```

## Opening Issues

If you encounter a bug with this package, we want to hear about it. Before opening a new issue, search the existing issues to avoid duplicates.
Expand Down

1 comment on commit 3574ed5

@lym953
Copy link
Contributor Author

@lym953 lym953 commented on 3574ed5 Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad. I pushed to main without a PR. But I think it should be okay because the changes are simple. Let me know if it doesn't look good to you.

Please sign in to comment.