docs(tracer): snippets split, improved, and lint#1261
Merged
heitorlessa merged 28 commits intoaws-powertools:developfrom Jun 23, 2022
Merged
docs(tracer): snippets split, improved, and lint#1261heitorlessa merged 28 commits intoaws-powertools:developfrom
heitorlessa merged 28 commits intoaws-powertools:developfrom
Conversation
…owertools-python into develop * 'develop' of https://github.com/heitorlessa/aws-lambda-powertools-python: chore(governance): warn message on closed issues
…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: docs(tracer): split and lint code snippets (aws-powertools#1260) fix(ci): quote prBody GH expr on_opened_pr
* develop: chore: move to approach B for multiple IaC chore: add sam build gitignore docs(tracer): split and lint code snippets (aws-powertools#1260) fix(ci): quote prBody GH expr on_opened_pr
Contributor
Author
|
Tracer finalized. Here's how the structure looks like for other examples - names match features in docs to ease discovery. Examples are now fully typed and improved too. tree examples
examples
└── tracer
├── sam
│ └── template.yaml
├── src
│ ├── capture_lambda_handler.py
│ ├── capture_method.py
│ ├── capture_method_async.py
│ ├── capture_method_async_concurrency.py
│ ├── capture_method_context_manager.py
│ ├── capture_method_generators.py
│ ├── disable_capture_error.py
│ ├── disable_capture_response.py
│ ├── disable_capture_response_streaming_body.py
│ ├── ignore_endpoints.py
│ ├── patch_modules.py
│ ├── put_trace_annotations.py
│ ├── put_trace_metadata.py
│ ├── sdk_escape_hatch.py
│ ├── tracer_reuse.py
│ ├── tracer_reuse_payment.py
│ └── tracing_aiohttp.py
└── template.yaml |
heitorlessa
added a commit
to heitorlessa/aws-lambda-powertools-python
that referenced
this pull request
Jun 23, 2022
…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: docs(tracer): snippets split, improved, and lint (aws-powertools#1261) fix(ci): merged_pr add issues write access
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue number: #1260 (older PR)
Summary
Changes
This PR splits code snippets into a top-level
examplesfolder. Formatting and linting (make lint) were adjusted to includeexamplesfolder. We also introduce cfn-lint within pre-commit hooks to selectively lint changed infra files withinexamplesfolder.Convention
We'll keep all examples under
examplesfolder. Each feature will have its own source code that match what's in the documentation, followed by one or more infrastructure as code customers could use in the future.Example for Tracer
examples └── tracer ├── cdk │ └── all_cdk_project_files, dependencies, etc. ├── sam │ └── template.yaml ├── src │ └── capture_lambda_handler.py └── terraformCaveat
We need to ensure Lambda Powertools dependency/layer is used. In the case of Layers, we will need to upgrade the Layer version within
examplesas part of each release - @am29d your input is crucial here on the best way forward. Until Alex completes his Layer pipeline refactoring, we can build a workflow action to find/replace Layer ARN Version.Another caveat is that
cfn-lintdropped support for 3.6. We're using an officialcfn-lintGitHub Actions as a workaround.User experience
Example of adding an invalid SAM template for a code snippet
Code quality example using our set of rules
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
View rendered docs/core/tracer.md