Skip to content

Commit 182309d

Browse files
author
Tom McCarthy
committed
Merge branch 'develop' into improv/metrics_interface
2 parents 67a76db + 38ad17e commit 182309d

File tree

8 files changed

+187
-1
lines changed

8 files changed

+187
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the Title above -->
11+
<!--- How has this issue affected you? What are you trying to accomplish? -->
12+
13+
**What were you trying to accomplish?**
14+
15+
## Expected Behavior
16+
<!--- If you're describing a bug, tell us what should happen -->
17+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
18+
19+
## Current Behavior
20+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
21+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
22+
23+
## Possible Solution
24+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
25+
<!--- or ideas how to implement the addition or change -->
26+
27+
## Steps to Reproduce (for bugs)
28+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
29+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
30+
1.
31+
2.
32+
3.
33+
4.
34+
35+
## Environment
36+
37+
* **Powertools version used**:
38+
* **Packaging format (Layers, PyPi)**:
39+
* **AWS Lambda function runtime:**
40+
* **Debugging logs**
41+
42+
> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-python/#debug-mode)**
43+
44+
```python
45+
# paste logs here
46+
```

‎.github/ISSUE_TEMPLATE/documentation-improvements.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation improvements
3+
about: Suggest a documentation update
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
**What were you initially searching for in the docs?**
11+
<!-- Please help us understand how you looked for information that was either not available or unclear -->
12+
13+
**Is this related to an existing part of the documentation? Please share a link**
14+
15+
**Describe how we could make it clearer**
16+
17+
**If you have a proposed update, please share it here**

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature-request, triage
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/rfc.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: RFC
3+
about: Feature design and proposals
4+
title: 'RFC: '
5+
labels: RFC, triage
6+
assignees: ''
7+
8+
---
9+
10+
## Key information
11+
12+
* RFC PR: (leave this empty)
13+
* Related issue(s), if known:
14+
* Area: (i.e. Tracer, Metrics, Logger, etc.)
15+
* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-python/#tenets): (Yes/no)
16+
17+
## Summary
18+
[summary]: #summary
19+
20+
> One paragraph explanation of the feature.
21+
22+
## Motivation
23+
[motivation]: #motivation
24+
25+
> Why are we doing this? What use cases does it support? What is the expected outcome?
26+
27+
## Proposal
28+
[proposal]: #proposal
29+
30+
> This is the bulk of the RFC.
31+
32+
> Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it.
33+
34+
> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
35+
36+
## Drawbacks
37+
[drawbacks]: #drawbacks
38+
39+
> Why should we *not* do this?
40+
41+
> Do we need additional dependencies? Impact performance/package size?
42+
43+
## Rationale and alternatives
44+
[rationale-and-alternatives]: #rationale-and-alternatives
45+
46+
* **What other designs have been considered? Why not them?**
47+
* **What is the impact of not doing this?**
48+
49+
## Unresolved questions
50+
[unresolved-questions]: #unresolved-questions
51+
52+
> Optional, stash area for topics that need further development e.g. TBD

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**Issue #, if available:**
2+
3+
## Description of changes:
4+
5+
> One or two sentences as a summary of what's being changed
6+
7+
* [ ] [Meet tenets criteria](https://awslabs.github.io/aws-lambda-powertools-python/#tenets)
8+
* [ ] Update tests
9+
* [ ] Update docs
10+
* [ ] PR title follows [conventional commit semantics](https://github.com/awslabs/aws-lambda-powertools-python/blob/376ec0a2ac0d2a40e0af5717bef42ff84ca0d1b9/.github/semantic.yml#L2)
11+
12+
## Breaking change checklist
13+
14+
> Ignore if it's not a breaking change
15+
16+
**RFC issue #**:
17+
18+
* [ ] Migration process documented
19+
* [ ] Implement warnings (if it can live side by side)
20+
21+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

‎.github/workflows/python.yml renamed to ‎.github/workflows/python_build.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ jobs:
1717
max-parallel: 4
1818
matrix:
1919
python-version: [3.6, 3.7, 3.8]
20+
env:
21+
OS: ${{ matrix.os }}
22+
PYTHON: ${{ matrix.python-version }}
2023
steps:
2124
- uses: actions/checkout@v1
2225
- name: Set up Python ${{ matrix.python-version }}
@@ -29,3 +32,15 @@ jobs:
2932
run: make lint
3033
- name: Test with pytest
3134
run: make test
35+
- name: Security baseline
36+
run: make security-baseline
37+
- name: Complexity baseline
38+
run: make complexity-baseline
39+
- name: Upload coverage to Codecov
40+
uses: codecov/codecov-action@v1
41+
with:
42+
file: ./coverage.xml
43+
# flags: unittests
44+
env_vars: OS,PYTHON
45+
name: aws-lambda-powertools-python-codecov
46+
fail_ci_if_error: true

‎.github/workflows/release-drafter.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
# branches to consider in the event; optional, defaults to all
6+
branches:
7+
- develop
8+
9+
jobs:
10+
update_release_draft:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: release-drafter/release-drafter@v5
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ lint: format
1818
poetry run flake8
1919

2020
test:
21-
poetry run pytest -vvv
21+
poetry run pytest -vvv --cov=./ --cov-report=xml
2222

2323
coverage-html:
2424
poetry run pytest --cov-report html

0 commit comments

Comments
 (0)