GeezerVison

{{ if .Versions -}}

<a name="unreleased"></a>

{{ if .Unreleased.CommitGroups -}}

{{ range .Unreleased.CommitGroups -}}

{{ range .Commits -}}

* {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}

<a name="{{ .Tag.Name }}"></a>

{{ range .CommitGroups -}}

{{ range .Commits -}}

* {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}

{{ end }}

{{ end -}}

{{- if .RevertCommits -}}

{{ range .RevertCommits -}}

* {{ .Revert.Header }}

{{ end }}

{{ end -}}

{{- if .MergeCommits -}}

{{ range .MergeCommits -}}

* {{ .Header }}

{{- if .NoteGroups -}}

{{ range .NoteGroups -}}

{{ range .Notes }}

{{ .Body }}

{{ end }}

notes:

keywords:

- BREAKING CHANGE

# issues:

# prefix:

# - #

module.exports = async ({ github, context }) => {

const { RELEASE_TAG_VERSION } = process.env;

console.log(`Running post-release script for ${RELEASE_TAG_VERSION} version`);

const { RELEASE_VERSION } = process.env;

console.log(`Running post-release script for ${RELEASE_VERSION} version`);

await notifyRelease({

gh_client: github,

owner: context.repo.owner,

repository: context.repo.repo,

release_version: RELEASE_TAG_VERSION,

release_version: RELEASE_VERSION,

});

on:

release:

types: [published]

workflow_dispatch:

inputs:

version_to_publish:

description: "Version to be released in PyPi, Docs, and Lambda Layer, e.g. v1.26.4"

default: v1.26.4

required: true

jobs:

release:

runs-on: ubuntu-latest

outputs:

RELEASE_VERSION: ${{ steps.release_version.outputs.RELEASE_VERSION }}

env:

RELEASE_TAG_VERSION: ${{ github.event.release.tag_name || inputs.version_to_publish }}

steps:

- uses: actions/checkout@v3

with:

with:

python-version: "3.8"

- name: Set release notes tag

id: release_version

# transform tag format `v<version` to `<version`

run: |

- name: Ensure new version is also set in pyproject and CHANGELOG

run: |

- name: Install dependencies

run: make dev

- name: Run all tests, linting and baselines

run: make pr

- name: Bump package version

run: poetry version ${RELEASE_VERSION}

- name: Generate latest CHANGELOG

run: make changelog

- name: Setup git client

run: |

- name: Push project metadata and changelog to trunk

run: |

- name: Build python package and wheel

run: poetry build

- name: Upload to PyPi test

PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

- name: publish lambda layer in SAR by triggering the internal codepipeline

run: |

env:

# Maintenance: Migrate to new OAuth mechanism

AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}

AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

AWS_DEFAULT_REGION: eu-west-1

AWS_DEFAULT_OUTPUT: json

- name: Setup doc deploy

docs:

needs: release

runs-on: ubuntu-latest

env:

RELEASE_VERSION: ${{ needs.release.outputs.RELEASE_VERSION }}

steps:

- uses: actions/checkout@v3

with:

fetch-depth: 0

- name: Setup git client

run: |

- name: Build docs website and API reference

run: |

- name: Release API docs to release version

uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0

with:

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: ./api

keep_files: true

destination_dir: ${{ env.RELEASE_TAG_VERSION }}/api

destination_dir: ${{ env.RELEASE_VERSION }}/api

- name: Release API docs to latest

uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0

with:

github_token: ${{ secrets.GITHUB_TOKEN }}

publish_dir: ./api

keep_files: true

destination_dir: latest/api

post_release:

needs: release

runs-on: ubuntu-latest

env:

RELEASE_VERSION: ${{ needs.release.outputs.RELEASE_VERSION }}

steps:

- uses: actions/checkout@v3

- name: Close issues related to this release

uses: actions/github-script@v6

with:

github-token: ${{ secrets.GITHUB_TOKEN }}

script: |

name: Docs

on:

push:

branches:

- develop

paths:

- "docs/**"

- "CHANGELOG.md"

- "mkdocs.yml"

- "examples/**"

- [Triage Bug Reports](#triage-bug-reports)

- [Triage RFCs](#triage-rfcs)

- [Releasing a new version](#releasing-a-new-version)

- [Changelog generation](#changelog-generation)

- [Bumping the version](#bumping-the-version)

- [Drafting release notes](#drafting-release-notes)

- [Run end to end tests](#run-end-to-end-tests)

- [Releasing a documentation hotfix](#releasing-a-documentation-hotfix)

Firstly, make sure the commit history in the `develop` branch **(1)** it's up to date, **(2)** commit messages are semantic, and **(3)** commit messages have their respective area, for example `feat(logger): <change>`, `chore(ci): ...`).

There are three main steps to release a new version: Changelog generation, version bumping, and drafting release notes.

Reword through rebase and push with `--force-with-lease` once you're confident. This will ensure [CHANGELOG](./CHANGELOG.md) is always clear for customers looking to understand what changed in between releases - was that a bug? what new features and for which utility?

You can pre-generate a temporary CHANGELOG using `make changelog`. This will generate a `TMP_CHANGELOG.md` with all staged changes under the `unreleased` section.

Each unreleased line item is a commit. You can adjust them if you find the commit titles are insufficient to describe their intent. Once you're comfortable, bring these changes to the `CHANGELOG.md` with a new version heading like in previous versions.

Use `poetry version <major|minor|patch|specific version>` to bump the version. For example, you can use `poetry version minor` when releasing a minor version.

NOTE. Make sure both `CHANGELOG` and `pyproject.toml` are committed and pushed to the remote `develop` branch before proceeding.

The only step is to draft and publish a good release notes, everything else is automated.

You'll notice we group all changes based on their [labels](#labels) like `feature`, `bug`, `documentation`, etc.

**I spotted a typo or incorrect grouping - how do I fix it?**

Edit the respective PR title and update their [labels](#labels). Then run the [Release Drafter workflow](https://github.com/awslabs/aws-lambda-powertools-python/actions/workflows/release-drafter.yml) to update the Draft release.

The best part comes now. Replace the placeholder `[Human readable summary of changes]` with what you'd like to communicate to customers what this release is all about. Always put yourself in the customers shoes. For that, these are some questions to keep in mind when drafting your first or future release notes:

**All looking good, what's next?**

The best part comes now. Replace the placeholder `[Human readable summary of changes]` with what you'd like to communicate to customers what this release is all about. Rule of thumb: always put yourself in the customers shoes.

These are some questions to keep in mind when drafting your first or future release notes:

- Can customers understand at a high level what changed in this release?

- Is there a link to the documentation where they can read more about each main change?

- Are there any graphics or code snippets that can enhance readability?

- Are there any graphics or [code snippets](carbon.now.sh/) that can enhance readability?

- Are we calling out any key contributor(s) to this release?

- All contributors are automatically credited, use this as an exceptional case to feature them

Once you're happy, hit `Publish release`. This will kick off the [Publishing workflow](https://github.com/awslabs/aws-lambda-powertools-python/actions/workflows/publish.yml) and within a few minutes you should see the latest version in PyPi, and all issues labeled as `pending-release` will be notified.

Once you're happy, hit `Publish release` 🎉🎉🎉.

This will kick off the [Publishing workflow](https://github.com/awslabs/aws-lambda-powertools-python/actions/workflows/publish.yml) and within a few minutes you should see the latest version in PyPi, and all issues labeled as `pending-release` will be closed and notified.

In order to run end to end tests you need to install CDK CLI first and bootstrap your account with `cdk bootstrap` command. For additional details follow [documentation](https://docs.aws.amazon.com/cdk/v2/guide/bootstrapping.html).

To run locally, export `AWS_PROFILE` environment variable and run `make e2e tests`. To run from GitHub Actions, use [run-e2e-tests workflow](https://github.com/awslabs/aws-lambda-powertools-python/actions/workflows/run-e2e-tests.yml) and pick the branch you want to run tests against.

**NOTE**: E2E tests are run as part of each merge to `develop` branch.

You can rebuild the latest documentation without a full release via this [GitHub Actions Workflow](https://github.com/awslabs/aws-lambda-powertools-python/actions/workflows/rebuild_latest_docs.yml). Choose `Run workflow`, keep `develop` as the branch, and input the latest Powertools version available.

changelog:

git fetch --tags origin

@echo "[+] Pre-generating CHANGELOG for tag: $$(git describe --abbrev=0 --tag)"

docker run -v "${PWD}":/workdir quay.io/git-chglog/git-chglog $$(git describe --abbrev=0 --tag).. > TMP_CHANGELOG.md

CURRENT_VERSION=$(shell git describe --abbrev=0 --tag) ;\

echo "[+] Pre-generating CHANGELOG for tag: $$CURRENT_VERSION" ;\

docker run -v "${PWD}":/workdir quay.io/git-chglog/git-chglog > CHANGELOG.md

mypy:

poetry run mypy --pretty aws_lambda_powertools