Skip to content

Commit

Permalink
feat: distribute go repository (#573)
Browse files Browse the repository at this point in the history
* feat: distribute go repository
* fix(doc): add basic instructions to use go
* fix: shield badge location

---------

Signed-off-by: Scott Schreckengaust <[email protected]>
Co-authored-by: Alain Krok <[email protected]>
  • Loading branch information
scottschreckengaust and krokoko authored Aug 8, 2024
1 parent 486c810 commit de04bc6
Show file tree
Hide file tree
Showing 7 changed files with 99 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/build.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 37 additions & 0 deletions .github/workflows/release.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions .mergify.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .projen/tasks.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .projenrc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ const project = new awscdk.AwsCdkConstructLibrary({
packageId: camelCaseIt(PUBLICATION_NAMESPACE)+'.'+camelCaseIt(PROJECT_NAME),
},

publishToGo: {
moduleName: `github.com/${PUBLICATION_NAMESPACE}/${PROJECT_NAME}-go`,
},

codeCov: true,
codeCovTokenSecret: 'CODECOV_TOKEN',

Expand Down Expand Up @@ -150,6 +154,7 @@ project.github?.actions.set('actions/download-artifact@v4', 'actions/download-ar
project.github?.actions.set('actions/github-script@v6', 'actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410');
project.github?.actions.set('actions/setup-dotnet@v3', 'actions/setup-dotnet@4d6c8fcf3c8f7a60068d26b594648e99df24cee3');
project.github?.actions.set('actions/setup-dotnet@v4', 'actions/setup-dotnet@4d6c8fcf3c8f7a60068d26b594648e99df24cee3');
project.github?.actions.set('actions/setup-go@v5', 'actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32');
project.github?.actions.set('actions/setup-node@v3', 'actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8'); // https://github.com/projen/projen/issues/3529
project.github?.actions.set('actions/setup-node@v4', 'actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8');
project.github?.actions.set('actions/setup-python@v4', 'actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d'); // https://github.com/projen/projen/issues/3529
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
[![PyPI version](https://img.shields.io/pypi/v/cdklabs.generative-ai-cdk-constructs)](https://pypi.org/project/cdklabs.generative-ai-cdk-constructs/)
[![npm version](https://img.shields.io/npm/v/@cdklabs/generative-ai-cdk-constructs)](https://www.npmjs.com/package/@cdklabs/generative-ai-cdk-constructs)
[![NuGet Version](https://img.shields.io/nuget/v/Cdklabs.GenerativeAiCdkConstructs)](https://nuget.info/packages/Cdklabs.GenerativeAiCdkConstructs)
[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/cdklabs/generative-ai-cdk-constructs-go?filename=generative-ai-cdk-constructs%2Fgo.mod)(https://github.com/cdklabs/generative-ai-cdk-constructs-go)]

## Table of contents

Expand Down Expand Up @@ -77,6 +78,16 @@ If you want to add a new construct to the library, check out our [design guideli
- Use the namespace:
- `using Cdklabs.GenerativeAiCdkConstructs;`

### For Go
- Create or use an existing CDK application in Python
- `cdk init app --language go`
- Get the module:
- `go get github.com/cdklabs/generative-ai-cdk-constructs-go/generative-ai-cdk-constructs`
- Import the library:
- `import "github.com/cdklabs/generative-ai-cdk-constructs-go/generative-ai-cdk-constructs"`

_NOTE: The [Go distribution repository](https://github.com/cdklabs/generative-ai-cdk-constructs-go), distributes the JSII tar gzipped versioned source from the [source repository](https://github.awslabs/generative-ai-cdk-constructs)_

Refer to the documentation for additional guidance on a particular construct: [Catalog](#catalog)

## Catalog
Expand Down
4 changes: 4 additions & 0 deletions package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit de04bc6

Please sign in to comment.