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

feat(examples): added sam example to workflows #849

Merged
merged 6 commits into from
May 12, 2022

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented May 11, 2022

Description of your changes

In a recent PR (#674) we received a contribution that added SAM examples to the repo. This PR aims at incorporating these examples into the CI/CD workflows we have at the moment. This includes linting of the sources, as well as building (sam build), and extremely basic unit tests that ensure that the functions can be imported & called.

List of changes:

  • Changed symlink from examples/sam/src/handlers to examples/sam/src, to conform to the structure needed by the linting commands (updated README & template.yml, no effect on the actual sample).
  • Added config files needed for the sample to be part of the workflows (tsconfig, jest.config, package-lock, etc.).
  • Added scripts stanza to the package.json to support various commands.
  • Added the sample to lerna's configs.
  • Modified workflows to include additional step that installs dependencies in the sample folder.
  • Added basic jest tests (full coverage of these functions is out of scope at the moment).
  • Fixed linting issues.
  • Minor housekeeping in another file belonging to the examples/cdk folder that I came across while copying parts of the code.

How to verify this change

Check the execution result of the GitHub actions included in this PR.

Related issues, RFCs

#674

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • The PR title follows the conventional commit semantics

Breaking change checklist

N/A


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi self-assigned this May 11, 2022
flochaz
flochaz previously approved these changes May 11, 2022
@dreamorosi dreamorosi added this to the production-ready-release milestone May 11, 2022
@dreamorosi dreamorosi changed the title feat: added sam example to workflows feat(examples): added sam example to workflows May 11, 2022
@dreamorosi dreamorosi marked this pull request as ready for review May 11, 2022 17:27
@flochaz flochaz merged commit 93f1c7b into main May 12, 2022
@flochaz flochaz deleted the feat/add_sam_example_cicd branch May 12, 2022 07:05
dreamorosi added a commit that referenced this pull request Aug 2, 2022
* feat: added sam example to workflows

* chore: added package-lock

* Modified symlink

* Fix import

* Added jest to sam

* Added jest to sam
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants