Skip to content

chore(examples): cleanup old examples #903

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

Merged
merged 2 commits into from
Jun 1, 2022

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR aims at removing unused and obsolete examples that were initially created in the very early stages of the project and that later went unmaintained. Now that the repo has two examples in CDK and SAM under the examples folder, the ones that were under of the packages/logger and packages/metrics folders can be removed.

The diff for this PR is big as each example had its own file. Aside from the files removed the changes include:

  • Edits in all the README files to remove links to these folders
  • Edit in the main page of the documentation where these folders were mentioned
  • Edits in the pacakges/[logger|metrics]/package.json files to remove the npm scripts to run these examples
  • Minor edit in one of the unit test files that was referencing an interface defined in these examples

When merged this issue will close #332

How to verify this change

See existing unit tests pass successfully on GitHub actions.

Related issues, RFCs

#332

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 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
  • 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 added this to the production-ready-release milestone May 25, 2022
@dreamorosi dreamorosi self-assigned this May 25, 2022
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label May 25, 2022
@dreamorosi dreamorosi marked this pull request as ready for review May 25, 2022 21:57
Copy link
Contributor

@ijemmy ijemmy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the change on Lambda interface is intentional.

Apart from that, I'm good with this change.

Comment on lines +15 to +21
import { Context, Handler } from 'aws-lambda';
import { Console } from 'console';

interface LambdaInterface {
handler: Handler
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we add this interface?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's needed for the decorator unit test cases, Tracer has one like this as well.

Before this PR it used to be in a separate file inside the now deleted folder. I have added it to this file instead of living a folder with one single file of 3 lines.

@dreamorosi dreamorosi merged commit 2977008 into main Jun 1, 2022
@dreamorosi dreamorosi deleted the chore/aamorosi/cleanup_examples branch June 1, 2022 14:20
dreamorosi added a commit that referenced this pull request Aug 2, 2022
* chore: cleaned up examples + removed links

* chore: remove leftovers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: delete examples in packages folder
3 participants