Skip to content

Commit 2e1eac9

Browse files
authored
docs(contributing): update codegen guidance (#3535)
1 parent 2363641 commit 2e1eac9

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ lerna run test --scope [package name]
113113
If `lerna` is not available in your environment, you can install it globally with:
114114

115115
```
116-
npm install -g lerna
116+
npm install -g lerna@3
117117
```
118118

119119
If you have touched multiple packages and you want to make sure the package
@@ -128,11 +128,32 @@ You don't need to run this command if the dependency packages are not changed.
128128

129129
### Generating Service Clients
130130

131-
Please refer [codegen](./codegen/README.md)
131+
If you made changes to either [AWS Smithy TypeScript generator](./codegen/smithy-aws-typescript-codegen)
132+
or [Smithy TypeScript generator][smithy typescript repo], you should include
133+
the generated code change to your PR. Here's how to generate clients:
134+
135+
1. Clone and checkout smithy-typescript repo
136+
```
137+
git clone https://github.com/awslabs/smithy-typescript.git && cd smithy-typescript
138+
git checkout [working_branch]
139+
```
140+
141+
1. Build the local branch and publish locally:
142+
```
143+
./gradlew clean build publishToMavenLocal
144+
```
145+
146+
1. Generate service clients in JavaScript SDK repo:
147+
```
148+
yarn generate-clients
149+
```
150+
`generate-clients` is a util script to facilitate the code generation. For more
151+
information, please refer [codegen](./codegen/README.md)
132152
133153
[issues]: https://github.com/aws/aws-sdk-js-v3/issues
134154
[pr]: https://github.com/aws/aws-sdk-js-v3/pulls
135155
[license]: http://aws.amazon.com/apache2.0/
136156
[cla]: http://en.wikipedia.org/wiki/Contributor_License_Agreement
137157
[aws service models]: https://github.com/aws/aws-sdk-js-v3/tree/main/models
138158
[conventional commits]: https://www.conventionalcommits.org/
159+
[smithy typescript repo]: https://github.com/awslabs/smithy-typescript

0 commit comments

Comments
 (0)