Checklist before GA

[heitorlessa]

UPDATE: Metrics.add_namespace and POWERTOOLS_METRICS_NAMESPACE will be removed during GA.

Creating a checklist of activities to remember after finishing docs website

• Set coverage bar
• Clean up tests with GIVEN/WHEN/THEN
• Contributing guide
• Enable automation for repo management
  • Semantic pull requests
  • Release drafter
  • Workflow to publish to PyPi on release published
  • Stale issues
  • Codecov
  • LGTM
  • pre-commit
• Align Metrics API with the core utilities (e.g. service param)
• Include security and complexity in CI flow
• GitHub Issue templates
  • Pull Request, including checklists
  • RFC
  • Feature request
  • Bug report
• Label PRs, and cut 1.0.0 release notes
• Main docs website to live under /<runtime>
• Confirm whether pytest has now support for pyproject.toml
• Add disclaimer that only Lambda official runtimes will be supported
• Add note of appreciation for main contributors in GA PR
• Investigate CI Build Wheel for GitHub Actions
• Experiment with Probot, semantic release bot, dependabot config
• Rename repo to aws-lambda-powertools-python
• Convert CHANGELOG to use KeepAChangeLog semantics
• Build docs in develop, and both docs in master
• Dependabot diffs for version bump
• Fix WACG code text contrast issues

Note - Checklist updated We might need to break into multiple repos as most tools are language specific, docs layout are vastly different, and dependabot can't seem to get multiple CHANGELOGs

[michaelbrewer]

@heitorlessa i was about to mention that the CHANGELOG.md file was not conforming to Keep a Changelog format. Which is probably why depedabot is not probably picking up the diff between releases. But i see you have it on your TODO list :)

[heitorlessa]

I’m kinda puzzled it’s not picking up - I initially thought it wasn’t picking up because we had CHANGELOG in a subfolder. I’ll have to setup a dummy project, a dummy package, and probably look into dependabot code to understand how they fetch them. I’ll create an issue to investigate that :)

…

On Sun, 31 May 2020 at 05:46, Michael Brewer ***@***.***> wrote: @heitorlessa <https://github.com/heitorlessa> i was about to mention that the CHANGELOG.md file was not conforming to Keep a Changelog format <https://keepachangelog.com/en/0.3.0/>. Which is probably why depedabot is not probably picking up the diff between releases. But i see you have it on your TODO list :) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#33 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBCOWFJPZTKEV62EHM3RUHOI3ANCNFSM4NDABB4A> .

[michaelbrewer]

@heitorlessa to be clear. It is picking up the changelog file. It is just not selecting the diff, because the sections in the changelog does not have anchors on the release names. So it shows the whole file.

So by updating the format to be more of a “standard” it should do both.

[heitorlessa]

Ah! Thanks for clarifying - I've just merged a PR from Tom that converts our CHANGELOG to Keep a Changelog format

…

On Mon, 1 Jun 2020 at 04:44, Michael Brewer ***@***.***> wrote: @heitorlessa <https://github.com/heitorlessa> to be clear. It is picking up the changelog file. It is just not selecting the diff, because the sections in the changelog does not have anchors on the release names. So it shows the whole file. So by updating the format to be more of a “standard” it should do both. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#33 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBDLMUWU3MRGCSQ6RNLRUMPZ7ANCNFSM4NDABB4A> .

[michaelbrewer]

There are some great tools from conventional commit site that can generate this from you git commits and git tags. So you don’t have to had craft it.

[heitorlessa]

Yep - I checked them out. I’ll opt to partially generate the release notes, but handcraft it as I didn’t like any generated Changelog I’ve seen out there - It didn’t feel like it was for humans

…

On Mon, 1 Jun 2020 at 18:04, Michael Brewer ***@***.***> wrote: There are some great tools from conventional commit site that can generate this from you git commits and git tags. So you don’t have to had craft it. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#33 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBEU7MSTWI2NBIQ7MNLRUPNQ5ANCNFSM4NDABB4A> .

[michaelbrewer]

@heitorlessa - CHANGELOG.md diffs are now 100% working with dependabot.

[heitorlessa]

@cakepietoast updated GA description to add a note that Metrics method on adding a namespace and its env var will change before we go GA.