Skip to content
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

Docs: add SAM support in examples folder #606

Closed
saragerion opened this issue Mar 1, 2022 · 7 comments
Closed

Docs: add SAM support in examples folder #606

saragerion opened this issue Mar 1, 2022 · 7 comments
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@saragerion
Copy link
Contributor

Description of the feature request

Add examples of usage of the utilities in the examples folder.

Problem statement

Summary of the feature

  • Infrastructure
  • Lambda handler(s) code in TypeScript
  • Readme with deployment guide
  • References to this sample in the project documentation

Code examples

CDK example for reference:
https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk

Benefits for you and the wider AWS community

Developers who use SAM can get started more quickly

Describe alternatives you've considered

Other IaC tool, which can be added later on in the roadmap.

Related issues, RFCs

docs(all): add CDK, Terraform, Serverless Framework, Terraform, Amplify examples
docs(examples): CDK example improvement with best practices

@saragerion saragerion added the triage This item has not been triaged by a maintainer, please wait label Mar 1, 2022
@dreamorosi dreamorosi added this to the production-ready-release milestone Mar 1, 2022
@dreamorosi dreamorosi added documentation Improvements or additions to documentation utility:all and removed triage This item has not been triaged by a maintainer, please wait labels Mar 1, 2022
@dreamorosi
Copy link
Contributor

Thank you Sara for opening the issue, as soon as we have a resolver please ask them know if they could leave a comment here so we can assign the issue & mark it as "in progress".

@bpauwels
Copy link
Contributor

bpauwels commented Mar 1, 2022

I will be picking up this issue

@flochaz
Copy link
Contributor

flochaz commented Mar 1, 2022

I gave it a try few weeks ago if it can help : https://github.com/flochaz/powertools-javascript-sam-sample

@bpauwels
Copy link
Contributor

I have just created the following PR: #674

As a reference, I used the API example that comes with AWS SAM. I have translated it into TypeScript and added the Powertools-Features to it.

@dreamorosi dreamorosi assigned dreamorosi and unassigned dreamorosi Apr 19, 2022
@dreamorosi dreamorosi linked a pull request Apr 19, 2022 that will close this issue
11 tasks
@dreamorosi dreamorosi removed a link to a pull request Apr 21, 2022
11 tasks
@dreamorosi
Copy link
Contributor

Before closing this issue and after #674 has been merged, we need another PR to apply linting, formatting, etc. to the new examples folder. Change needed in:

  • lerna.json
  • .github/workflows/*

This way the new files will be picked up by the existing CI/CD steps.

@dreamorosi
Copy link
Contributor

In #849 we have added the new SAM samples to the GitHub workflows so that these samples are listed, basic tested, and built as part of the CI/CD workflow.

@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues 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.

@dreamorosi dreamorosi changed the title Examples: add SAM support in examples folder Feature (examples): add SAM support in examples folder May 12, 2022
@dreamorosi dreamorosi changed the title Feature (examples): add SAM support in examples folder Docs: add SAM support in examples folder Nov 14, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
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
None yet
Development

No branches or pull requests

4 participants