Skip to content

Docs: document steps to publish layers in a new region #1981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
dreamorosi opened this issue Jan 26, 2024 · 3 comments · Fixed by #2323
Closed
1 task done

Docs: document steps to publish layers in a new region #1981

dreamorosi opened this issue Jan 26, 2024 · 3 comments · Fixed by #2323
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@dreamorosi
Copy link
Contributor

What were you searching in the docs?

Currently when adding a new commercial region to the Lambda Layers we rely on an undocumented process which has proven to be error prone.

We should have these steps documented in the maintainers' handbook.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/typescript/latest/maintainers/#maintainer-responsibilities

How can we improve?

We should add a dedicated section to the maintainers handbook that details the steps needed to publish layers in a new region for the first time.

This can be in the form of a checklist or a paragraph, but it should cover all the actions needed before making a release that involve a new region where Lambda Layer is published.

Got a suggestion in mind?

On the top of my head the steps should be:

  • bootstrap the new region both in the layers beta & prod accounts (this includes opting in + running CDK bootstrap)
  • align the layer version to the latest so that the next release yields the same version number across regions (ideally include the script used either in the repo or the GH organization if shared with Python)
  • add the region to the list in the workflow
  • add the ARN in the docs

I might be missing some steps so please feel free to complement

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@dreamorosi dreamorosi added documentation Improvements or additions to documentation confirmed The scope is clear, ready for implementation labels Jan 26, 2024
@dreamorosi dreamorosi moved this from Triage to Backlog in Powertools for AWS Lambda (TypeScript) Jan 27, 2024
@am29d am29d self-assigned this Feb 12, 2024
@dreamorosi dreamorosi assigned am29d and unassigned am29d Apr 5, 2024
@dreamorosi dreamorosi moved this from Backlog to Working on it in Powertools for AWS Lambda (TypeScript) Apr 5, 2024
@dreamorosi
Copy link
Contributor Author

I'm going to take the issue and open a PR shortly.

Copy link
Contributor

github-actions bot commented Apr 5, 2024

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Apr 5, 2024
Copy link
Contributor

This is now released under v2.0.4 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Apr 10, 2024
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
2 participants