Skip to content

Commit a0c0ffc

Browse files
authored
improv(docs): updated the Maintainer's Playbook with the updated CI process (#4922)
1 parent 7f84229 commit a0c0ffc

1 file changed

Lines changed: 6 additions & 16 deletions

File tree

docs/maintainers.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Be aware of recurring ambiguous situations and [document them](#common-scenarios
100100

101101
### Uphold Code of Conduct
102102

103-
Model the behavior set forward by the [Code of Conduct](https://github.com/aws-powertools/powertools-lambda-typescript/blob/develop/CODE_OF_CONDUCT.md){target="_blank"} and raise any violations to other maintainers and admins. There could be unusual circumstances where inappropriate behavior does not immediately fall within the [Code of Conduct](https://github.com/aws-powertools/powertools-lambda-typescript/blob/develop/CODE_OF_CONDUCT.md){target="_blank"}.
103+
Model the behavior set forward by the [Code of Conduct](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CODE_OF_CONDUCT.md){target="_blank"} and raise any violations to other maintainers and admins. There could be unusual circumstances where inappropriate behavior does not immediately fall within the [Code of Conduct](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CODE_OF_CONDUCT.md){target="_blank"}.
104104

105105
These might be nuanced and should be handled with extra care - when in doubt, do not engage and reach out to other maintainers and admins.
106106

@@ -176,21 +176,11 @@ tests, 5/ update the documentation with the new version.
176176
4. **Review and approve docs PR**: Once the `Make Release` workflow is complete, a PR will be created to update the
177177
documentation with the new version. Review and approve this PR **but do not merge it yet**. Take note of the Lambda
178178
layer version that was deployed, as this will be used in the next steps.
179-
5. **Publish GovCloud Layers (Gamma)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch,
180-
targeting the `Gamma` deployment environment and the GovCloud partition, using the Lambda layer version from the
181-
step 4. This will publish the Lambda layers to the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions.
182-
6. **Publish GovCloud Layers (Prod)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch,
183-
targeting the `Prod` deployment environment and the GovCloud partition, using the Lambda layer version from step 4.
184-
This will publish the Lambda layers to the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions.
185-
7. **Publish China Layer (Gamma)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch, targeting
186-
the `Gamma` deployment environment and the China partition, using the Lambda layer version from step 4. This will
187-
publish the Lambda layer to the AWS China (Beijing) Region.
188-
8. **Publish China Layer (Prod)**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch,
189-
targeting the `Prod` deployment environment and the China partition, and using the Lambda layer version from step 4.
190-
This will publish the Lambda layer to the AWS China (Beijing) Region.
191-
9. **Merge docs PR**: Once the `Layer Deployment (Partition)` workflow for the production China partition is complete,
179+
5. **Publish GovCloud Layers**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch, targeting the `GovCloud` partition. This will publish the Lambda layers to the AWS GovCloud (US-East) and AWS GovCloud (US-West) Regions.
180+
6. **Publish China Layer**: Run the `Layer Deployment (Partitions)` workflow with the `main` branch, targeting the `China` partition. This will publish the Lambda layer to the AWS China (Beijing) Region.
181+
7. **Merge docs PR**: Once the `Layer Deployment (Partition)` workflow for the production China partition is complete,
192182
merge the PR from step 4 to update the documentation with the new version.
193-
10. **Update Docs**: Run the `Rebuild latest docs` workflow with the `main` branch using the package version from
183+
8. **Update Docs**: Run the `Rebuild latest docs` workflow with the `main` branch using the package version from
194184
npm (i.e. `2.20.0`). This will update the documentation with the new version.
195185

196186
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.
@@ -349,7 +339,7 @@ Finally, add the new region to the [`region` matrix](https://github.com/aws-powe
349339
### Negative Impact on the Project
350340

351341
<!-- markdownlint-disable MD013 -->
352-
Actions that negatively impact the project will be handled by the admins, in coordination with other maintainers, in balance with the urgency of the issue. Examples would be [Code of Conduct](https://github.com/aws-powertools/powertools-lambda-typescript/blob/develop/CODE_OF_CONDUCT.md){target="_blank"} violations, deliberate harmful or malicious actions, spam, monopolization, and security risks.
342+
Actions that negatively impact the project will be handled by the admins, in coordination with other maintainers, in balance with the urgency of the issue. Examples would be [Code of Conduct](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CODE_OF_CONDUCT.md){target="_blank"} violations, deliberate harmful or malicious actions, spam, monopolization, and security risks.
353343
<!-- markdownlint-enable MD013 -->
354344

355345
### Becoming a maintainer

0 commit comments

Comments
 (0)