Skip to content

Commit 55e34b0

Browse files
committed
docs: update release steps in maintainers section
1 parent 204e2d7 commit 55e34b0

File tree

1 file changed

+68
-15
lines changed

1 file changed

+68
-15
lines changed

docs/maintainers.md

Lines changed: 68 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -165,17 +165,63 @@ Some examples using our initial and new RFC templates: [#447](https://github.com
165165

166166
Releasing a new version is a multi-step process that requires up to 3 hours to complete. Below a checklist of the main steps to follow:
167167

168-
1. **End to end tests**: Run the [e2e tests](#run-end-to-end-tests) and make sure they pass.
169-
2. **Version bump**: Run the `Make Version` workflow to bump the version. This will create a PR with the new version and a changelog. Visually inspect the diff and make sure the changelog and version are correct, then merge the PR.
170-
3. **Make Release**: Run the `Make Release` workflow. This will: 1/ run the unit tests again, 2/ build and publish to npmjs.com, 3/ build and deploy the Lambda layers to beta and prod, 4/ run canary tests, 5/ update the documentation with the new version.
171-
4. **Review and approve docs PR**: Once the `Make Release` workflow is complete, a PR will be created to update the documentation with the new version. Review and approve this PR **but do not merge it yet**. Take note of the Lambda layer version that was deployed, as this will be used in the next step.
172-
5. **Publish GovCloud Layers (Gamma)**: Run the `Layer Deployment (GovCloud)` workflow with the `main` branch, targeting the `gamma` account, and using the Lambda layer version from the previous step. This will publish the Lambda layers to GovCloud. Visually inspect the output JSON files and make sure the Lambda layer version and package version are correct.
173-
6. **Publish GovCloud Layers (Prod)**: Run the `Layer Deployment (GovCloud)` workflow with the `main` branch, targeting the `prod` account, and using the Lambda layer version from the previous step. This will publish the Lambda layers to GovCloud. Visually inspect the output JSON files and make sure the Lambda layer version and package version are correct.
174-
7. **Merge docs PR**: Once the `Layer Deployment (GovCloud)` workflow is complete, merge the PR to update the documentation with the new version.
175-
8. **Update SSM Parameters (Beta)**: Run the `SSM Parameters` workflow with the `main` branch, targeting the `beta` account, and using the package version from npm (i.e. `2.20.0`) and Lambda layer version from the previous steps. This will update the SSM parameters with the new version.
176-
9. **Verify SSM Parameters (Beta)**: Use the AWS CLI to verify that the SSM parameters were updated correctly. Run the following command: `aws ssm get-parameter --name=/aws/service/powertools/typescript/generic/all/latest` and `aws ssm get-parameter --name=/aws/service/powertools/typescript/generic/all/<version>` to verify that the SSM parameters were updated correctly.
177-
10. **Update SSM Parameters (Prod)**: Run the `SSM Parameters` workflow with the `main` branch, targeting the `prod` account, and using the package version from npm (i.e. `2.20.0`) and Lambda layer version from the previous steps. This will update the SSM parameters with the new version.
178-
11. **Update Docs**: Run the `Rebuild latest docs` workflow with the `main` branch using the package version from npm (i.e. `2.20.0`). This will update the documentation with the new version.
168+
1. **End to end tests**: Run the [e2e tests](#run-end-to-end-tests) and ensure they pass.
169+
2. **Version bump**: Run the `Make Version` workflow to bump the version. This will create a PR with the new version and
170+
a changelog. Visually inspect the diff and make sure the changelog and version are correct, then merge the PR.
171+
3. **Make Release**: Run the `Make Release` workflow. This will: 1/ run the unit tests again, 2/ build and publish to npmjs.com,
172+
3/ build and deploy the Lambda layers to the `Beta` and `Prod` environments in all commercial Regions, 4/ run canary
173+
tests, 5/ update the documentation with the new version.
174+
4. **Review and approve docs PR**: Once the `Make Release` workflow is complete, a PR will be created to update the
175+
documentation with the new version. Review and approve this PR **but do not merge it yet**. Take note of the Lambda
176+
layer version that was deployed, as this will be used in the next steps.
177+
5. **Publish GovCloud Layers (Gamma)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch,
178+
targeting the `Gamma` deployment environment and the GovCloud partition, using the Lambda layer version from the
179+
step 4. This will publish the Lambda layers to the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions.
180+
6. **Verify GovCloud Layers (Gamma)**: Download the `AWSLambdaPowertoolsTypeScriptV2-us-gov-east-1.json` and
181+
`AWSLambdaPowertoolsTypeScriptV2-us-gov-west-1.json` ZIP files. Unzip the files, inspect the JSON files therein and
182+
ensure the version number in the `Description` field (i.e., `Powertools for AWS Lambda (TypeScript) version 2.20.0`)
183+
and the layer version in the `LayerVersionArn` field (i.e., `arn:aws-us-gov:lambda:us-gov-east-1:164754790254:layer:AWSLambdaPowertoolsTypeScriptV2:31`)
184+
are correct.
185+
7. **Publish GovCloud Layers (Prod)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch,
186+
targeting the `Prod` deployment environment and the GovCloud partition, using the Lambda layer version from step 4.
187+
This will publish the Lambda layers to the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions.
188+
8. **Verify GovCloud Layers (Prod)**: Download the `AWSLambdaPowertoolsTypeScriptV2-us-gov-east-1.json` and
189+
`AWSLambdaPowertoolsTypeScriptV2-us-gov-west-1.json` ZIP files. Unzip the files, inspect the JSON files therein and
190+
ensure the version number in the `Description` field (i.e., `Powertools for AWS Lambda (TypeScript) version 2.20.0`)
191+
and the layer version in the `LayerVersionArn` field (i.e., `arn:aws-us-gov:lambda:us-gov-west-1:165093116878:layer:AWSLambdaPowertoolsTypeScriptV2:31`)
192+
are correct.
193+
9. **Publish China Layer (Gamma)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch, targeting
194+
the `Gamma` deployment environment and the China partition, using the Lambda layer version from step 4. This will
195+
publish the Lambda layer to the AWS China (Beijing) Region.
196+
10. **Verify China Layer (Gamma)**: Download the `AWSLambdaPowertoolsTypeScriptV2-cn-north-1.json` ZIP file. Unzip
197+
the file, inspect the JSON file therein and ensure the version number in the `Description` field
198+
(i.e., `Powertools for AWS Lambda (TypeScript) version 2.20.0`) and the layer version in the `LayerVersionArn` field
199+
(i.e., `arn:aws-cn:lambda:cn-north-1:498595349401:layer:AWSLambdaPowertoolsTypeScriptV2:31`) are correct.
200+
11. **Publish China Layer (Prod)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch,
201+
targeting the `Prod` deployment environment and the China partition, and using the Lambda layer version from step 4.
202+
This will publish the Lambda layer to the AWS China (Beijing) Region.
203+
12. **Verify China Layer (Prod)**: Download the `AWSLambdaPowertoolsTypeScriptV2-cn-north-1.json` ZIP file. Unzip the
204+
file, inspect the JSON file therein and ensure the version number in the `Description` field
205+
(i.e., `Powertools for AWS Lambda (TypeScript) version 2.20.0`) and the layer version in the `LayerVersionArn`
206+
field (i.e., `arn:aws-cn:lambda:cn-north-1:498634801083:layer:AWSLambdaPowertoolsTypeScriptV2:31`) are correct.
207+
13. **Merge docs PR**: Once the `Layer Deployment (Partition)` workflow for the production China partition is complete,
208+
merge the PR from step 4 to update the documentation with the new version.
209+
14. **Update SSM Parameters (Beta)**: Run the `SSM Parameters` workflow with the `main` branch, targeting the `beta`
210+
deployment environment, and using the package version from npm (i.e., `2.20.0`) and Lambda layer version from step 4.
211+
This will update the SSM parameters with the new version.
212+
15. **Verify SSM Parameters (Beta)**: Use the AWS CLI to verify that the SSM parameters were updated correctly. Run
213+
the following command: `aws ssm get-parameter --name=/aws/service/powertools/beta/typescript/generic/all/latest`
214+
and `aws ssm get-parameter --name=/aws/service/powertools/beta/typescript/generic/all/<version>` to verify that the
215+
SSM parameters were updated correctly.
216+
16. **Update SSM Parameters (Prod)**: Run the `SSM Parameters` workflow with the `main` branch, targeting the `prod`
217+
deployment environment, and using the package version from npm (i.e., `2.20.0`) and Lambda layer version from step 4.
218+
This will update the SSM parameters with the new version.
219+
17. **Verify SSM Parameters (Prod)**: Use the AWS CLI to verify that the SSM parameters were updated correctly. Run
220+
the following command: `aws ssm get-parameter --name=/aws/service/powertools/typescript/generic/all/latest`
221+
and `aws ssm get-parameter --name=/aws/service/powertools/typescript/generic/all/<version>` to verify that the
222+
SSM parameters were updated correctly.
223+
18. **Update Docs**: Run the `Rebuild latest docs` workflow with the `main` branch using the package version from
224+
npm (i.e. `2.20.0`). This will update the documentation with the new version.
179225

180226
Once complete, you can start drafting the release notes to let customers know **what changed and what's in it for them (a.k.a why they should care)**. We have guidelines in the release notes section so you know what good looks like.
181227

@@ -242,15 +288,22 @@ section GovCloud
242288
GovCloud layers published : milestone, m6
243289
244290
245-
section Documentation
291+
section China
292+
Publish China layers (Beta) : active, 8s
293+
Publish China layers (Prod) : active, 8s
294+
China layers published : milestone, m7
295+
296+
297+
section SSM
246298
Update SSM parameters (Beta) : active, 8s
247299
Update SSM parameters (Prod) : active, 8s
248300
249-
SSM Parameters updated: milestone, m7
301+
SSM Parameters updated: milestone, m8
250302
251-
Documentation release : milestone, m8
303+
section Documentation
304+
Documentation release : milestone, m9
252305
253-
Release complete : milestone, m9
306+
Release complete : milestone, m10
254307
```
255308

256309
#### Drafting release notes

0 commit comments

Comments
 (0)