diff --git a/.github/actions/create-pr/action.yml b/.github/actions/create-pr/action.yml
new file mode 100644
index 00000000000..b7713a6c785
--- /dev/null
+++ b/.github/actions/create-pr/action.yml
@@ -0,0 +1,88 @@
+name: "Create PR custom action"
+description: "Create a PR and a temporary branch, close duplicates"
+
+# PROCESS
+#
+# 1. Setup git client using Powertools bot username
+# 2. Pushes staged files to a temporary branch
+# 3. Creates a PR from temporary branch against a target branch (typically trunk: develop, main, etc.)
+# 4. Searches for duplicate PRs with the same title
+# 5. If duplicates are found, link to the most recent one, close and delete their branches so we keep a single PR
+# 6. In the event of failure, we delete the now orphaned branch (if any), and propagate the failure
+
+# USAGE
+#
+# - name: Create PR
+# id: create-pr
+# uses: ./.github/actions/create-pr
+# with:
+# files: "CHANGELOG.md"
+# temp_branch_prefix: "ci-changelog"
+# pull_request_title: "chore(ci): changelog rebuild"
+# github_token: ${{ secrets.GITHUB_TOKEN }}
+# - name: Step to demonstrate how to access outputs (no need for this)
+# run: |
+# echo "PR number: ${PR_ID}"
+# echo "Branch: ${BRANCH}"
+# env:
+# PR_ID: ${{ steps.create-pr.outputs.pull_request_id}}
+# BRANCH: ${{ steps.create-pr.outputs.temp_branch}}
+
+inputs:
+ files:
+ description: "Files to add separated by space"
+ required: true
+ temp_branch_prefix:
+ description: "Prefix for temporary git branch to be created, e.g, ci-docs"
+ required: true
+ pull_request_title:
+ description: "Pull Request title to use"
+ required: true
+ github_token:
+ description: "GitHub token for GitHub CLI"
+ required: true
+ target_branch:
+ description: "Branch to target when creating a PR against (develop, by default)"
+ required: false
+ default: develop
+
+outputs:
+ pull_request_id:
+ description: "Pull request ID created"
+ value: ${{ steps.create-pr.outputs.pull_request_id }}
+ temp_branch:
+ description: "Temporary branch created with staged changed"
+ value: ${{ steps.create-pr.outputs.temp_branch }}
+
+runs:
+ using: "composite"
+ steps:
+ - id: adjust-path
+ run: echo "${{ github.action_path }}" >> $GITHUB_PATH
+ shell: bash
+ - id: setup-git
+ name: Git client setup and refresh tip
+ run: |
+ git config user.name "Powertools bot"
+ git config user.email "aws-lambda-powertools-feedback@amazon.com"
+ git config pull.rebase true
+ git config remote.origin.url >&-
+ shell: bash
+ - id: create-pr
+ working-directory: ${{ env.GITHUB_WORKSPACE }}
+ run: create_pr_for_staged_changes.sh "${FILES}"
+ env:
+ FILES: ${{ inputs.files }}
+ TEMP_BRANCH_PREFIX: ${{ inputs.temp_branch_prefix }}
+ PR_TITLE: ${{ inputs.pull_request_title }}
+ BASE_BRANCH: ${{ inputs.target_branch }}
+ GH_TOKEN: ${{ inputs.github_token }}
+ shell: bash
+ - id: cleanup
+ name: Cleanup orphaned branch
+ if: failure()
+ run: git push origin --delete "${TEMP_BRANCH_PREFIX}-${GITHUB_RUN_ID}" || echo "Must have failed before creating temporary branch; no cleanup needed."
+ env:
+ TEMP_BRANCH_PREFIX: ${{ inputs.temp_branch_prefix }}
+ GITHUB_RUN_ID: ${{ github.run_id }}
+ shell: bash
diff --git a/.github/actions/create-pr/create_pr_for_staged_changes.sh b/.github/actions/create-pr/create_pr_for_staged_changes.sh
new file mode 100755
index 00000000000..2f32ab24342
--- /dev/null
+++ b/.github/actions/create-pr/create_pr_for_staged_changes.sh
@@ -0,0 +1,145 @@
+#!/bin/bash
+set -uo pipefail # prevent accessing unset env vars, prevent masking pipeline errors to the next command
+
+#docs
+#title :create_pr_for_staged_changes.sh
+#description :This script will create a PR for staged changes, detect and close duplicate PRs.
+#author :@heitorlessa
+#date :May 8th 2023
+#version :0.1
+#usage :bash create_pr_for_staged_changes.sh {git_staged_files_or_directories_separated_by_space}
+#notes :Meant to use in GitHub Actions only. Temporary branch will be named $TEMP_BRANCH_PREFIX-$GITHUB_RUN_ID
+#os_version :Ubuntu 22.04.2 LTS
+#required_env_vars :PR_TITLE, TEMP_BRANCH_PREFIX, GH_TOKEN
+#==============================================================================
+
+# Sets GitHub Action with error message to ease troubleshooting
+function error() {
+ echo "::error file=${FILENAME}::$1"
+ exit 1
+}
+
+function debug() {
+ TIMESTAMP=$(date -u "+%FT%TZ") # 2023-05-10T07:53:59Z
+ echo ""${TIMESTAMP}" - $1"
+}
+
+function notice() {
+ echo "::notice file=${FILENAME}::$1"
+}
+
+function start_span() {
+ echo "::group::$1"
+}
+
+function end_span() {
+ echo "::endgroup::"
+}
+
+function has_required_config() {
+ start_span "Validating required config"
+ test -z "${TEMP_BRANCH_PREFIX}" && error "TEMP_BRANCH_PREFIX env must be set to create a PR"
+ test -z "${PR_TITLE}" && error "PR_TITLE env must be set"
+ test -z "${GH_TOKEN}" && error "GH_TOKEN env must be set for GitHub CLI"
+
+ # Default GitHub Actions Env Vars: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
+ debug "Are we running in GitHub Action environment?"
+ test -z "${GITHUB_RUN_ID}" && error "GITHUB_RUN_ID env must be set to trace Workflow Run ID back to PR"
+ test -z "${GITHUB_SERVER_URL}" && error "GITHUB_SERVER_URL env must be set to trace Workflow Run ID back to PR"
+ test -z "${GITHUB_REPOSITORY}" && error "GITHUB_REPOSITORY env must be set to trace Workflow Run ID back to PR"
+
+ debug "Config validated successfully!"
+ set_environment_variables
+ end_span
+}
+
+function set_environment_variables() {
+ start_span "Setting environment variables"
+ export readonly WORKFLOW_URL="${GITHUB_SERVER_URL}"/"${GITHUB_REPOSITORY}"/actions/runs/"${GITHUB_RUN_ID}" # e.g., heitorlessa/aws-lambda-powertools-test/actions/runs/4913570678
+ export readonly TEMP_BRANCH="${TEMP_BRANCH_PREFIX}"-"${GITHUB_RUN_ID}" # e.g., ci-changelog-4894658712
+ export readonly BASE_BRANCH="${BASE_BRANCH:-develop}" # e.g., main, defaults to develop if missing
+ export readonly PR_BODY="This is an automated PR created from the following workflow"
+ export readonly FILENAME=".github/scripts/$(basename "$0")"
+ export readonly NO_DUPLICATES_MESSAGE="No duplicated PRs found"
+ end_span
+}
+
+function has_anything_changed() {
+ start_span "Validating git staged files"
+ HAS_ANY_SOURCE_CODE_CHANGED="$(git status --porcelain)"
+
+ test -z "${HAS_ANY_SOURCE_CODE_CHANGED}" && debug "Nothing to update; exitting early" && exit 0
+ end_span
+}
+
+function create_temporary_branch_with_changes() {
+ start_span "Creating temporary branch: "${TEMP_BRANCH}""
+ git checkout -b "${TEMP_BRANCH}"
+
+ debug "Committing staged files: $*"
+ echo "$@" | xargs -n1 git add || error "Failed to add staged changes: "$@""
+ git commit -m "${PR_TITLE}"
+
+ git push origin "${TEMP_BRANCH}"
+ end_span
+}
+
+function create_pr() {
+ start_span "Creating PR against ${TEMP_BRANCH} branch"
+ NEW_PR_URL=$(gh pr create --title "${PR_TITLE}" --body "${PR_BODY}: ${WORKFLOW_URL}" --base "${BASE_BRANCH}" || error "Failed to create PR") # e.g, https://github.com/awslabs/aws-lambda-powertools/pull/13
+
+ # greedy remove any string until the last URL path, including the last '/'. https://opensource.com/article/17/6/bash-parameter-expansion
+ debug "Extracing PR Number from PR URL: "${NEW_PR_URL}""
+ NEW_PR_ID="${NEW_PR_URL##*/}" # 13
+ export NEW_PR_URL
+ export NEW_PR_ID
+ end_span
+}
+
+function close_duplicate_prs() {
+ start_span "Searching for duplicate PRs"
+ DUPLICATE_PRS=$(gh pr list --search "${PR_TITLE}" --json number --jq ".[] | select(.number != ${NEW_PR_ID}) | .number") # e.g, 13\n14
+
+ if [ -z "${DUPLICATE_PRS}" ]; then
+ debug "No duplicate PRs found"
+ DUPLICATE_PRS="${NO_DUPLICATES_MESSAGE}"
+ else
+ debug "Closing duplicated PRs: "${DUPLICATE_PRS}""
+ echo "${DUPLICATE_PRS}" | xargs -L1 gh pr close --delete-branch --comment "Superseded by #${NEW_PR_ID}"
+ fi
+
+ export readonly DUPLICATE_PRS
+ end_span
+}
+
+function report_job_output() {
+ start_span "Updating job outputs"
+ echo pull_request_id="${NEW_PR_ID}" >>"$GITHUB_OUTPUT"
+ echo temp_branch="${TEMP_BRANCH}" >>"$GITHUB_OUTPUT"
+ end_span
+}
+
+function report_summary() {
+ start_span "Creating job summary"
+ echo "### Pull request created successfully :rocket: ${NEW_PR_URL}
Closed duplicated PRs: ${DUPLICATE_PRS}" >>"$GITHUB_STEP_SUMMARY"
+
+ notice "PR_URL is: ${NEW_PR_URL}"
+ notice "PR_BRANCH is: ${TEMP_BRANCH}"
+ notice "PR_DUPLICATES are: ${DUPLICATE_PRS}"
+ end_span
+}
+
+function main() {
+ # Sanity check
+ has_anything_changed
+ has_required_config
+
+ create_temporary_branch_with_changes "$@"
+ create_pr
+ close_duplicate_prs
+
+ report_job_output
+ report_summary
+}
+
+main "$@"
diff --git a/.github/scripts/create_pr_for_staged_changes.sh b/.github/scripts/create_pr_for_staged_changes.sh
deleted file mode 100644
index a35d45cc9e9..00000000000
--- a/.github/scripts/create_pr_for_staged_changes.sh
+++ /dev/null
@@ -1,116 +0,0 @@
-#!/bin/bash
-set -uxo pipefail # enable debugging, prevent accessing unset env vars, prevent masking pipeline errors to the next command
-
-#docs
-#title :create_pr_for_staged_changes.sh
-#description :This script will create a PR for staged changes and detect and close duplicate PRs.
-#author :@heitorlessa
-#date :May 8th 2023
-#version :0.1
-#usage :bash create_pr_for_staged_changes.sh {git_staged_files_or_directories_separated_by_space}
-#notes :Meant to use in GitHub Actions only. Temporary branch will be named $TEMP_BRANCH_PREFIX-$GITHUB_RUN_ID
-#os_version :Ubuntu 22.04.2 LTS
-#required_env_vars :COMMIT_MSG, PR_TITLE, TEMP_BRANCH_PREFIX, GH_TOKEN, GITHUB_RUN_ID, GITHUB_SERVER_URL, GITHUB_REPOSITORY
-#==============================================================================
-
-PR_BODY="This is an automated PR created from the following workflow"
-FILENAME=".github/scripts/$(basename "$0")"
-readonly PR_BODY
-readonly FILENAME
-
-# Sets GitHub Action with error message to ease troubleshooting
-function raise_validation_error() {
- echo "::error file=${FILENAME}::$1"
- exit 1
-}
-
-function debug() {
- echo "::debug::$1"
-}
-
-function notice() {
- echo "::notice file=${FILENAME}::$1"
-}
-
-function has_required_config() {
- # Default GitHub Actions Env Vars: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
- debug "Do we have required environment variables?"
- test -z "${TEMP_BRANCH_PREFIX}" && raise_validation_error "TEMP_BRANCH_PREFIX env must be set to create a PR"
- test -z "${GH_TOKEN}" && raise_validation_error "GH_TOKEN env must be set for GitHub CLI"
- test -z "${COMMIT_MSG}" && raise_validation_error "COMMIT_MSG env must be set"
- test -z "${PR_TITLE}" && raise_validation_error "PR_TITLE env must be set"
- test -z "${GITHUB_RUN_ID}" && raise_validation_error "GITHUB_RUN_ID env must be set to trace Workflow Run ID back to PR"
- test -z "${GITHUB_SERVER_URL}" && raise_validation_error "GITHUB_SERVER_URL env must be set to trace Workflow Run ID back to PR"
- test -z "${GITHUB_REPOSITORY}" && raise_validation_error "GITHUB_REPOSITORY env must be set to trace Workflow Run ID back to PR"
-
- set_environment_variables
-}
-
-function set_environment_variables() {
- WORKFLOW_URL="${GITHUB_SERVER_URL}"/"${GITHUB_REPOSITORY}"/actions/runs/"${GITHUB_RUN_ID}" # e.g., heitorlessa/aws-lambda-powertools-test/actions/runs/4913570678
- TEMP_BRANCH="${TEMP_BRANCH_PREFIX}"-"${GITHUB_RUN_ID}" # e.g., ci-changelog-4894658712
-
- export readonly WORKFLOW_URL
- export readonly TEMP_BRANCH
-}
-
-function has_anything_changed() {
- debug "Is there an update to the source code?"
- HAS_ANY_SOURCE_CODE_CHANGED="$(git status --porcelain)"
-
- test -z "${HAS_ANY_SOURCE_CODE_CHANGED}" && echo "Nothing to update" && exit 0
-}
-
-function create_temporary_branch_with_changes() {
- debug "Creating branch ${TEMP_BRANCH}"
- git checkout -b "${TEMP_BRANCH}"
-
- debug "Committing staged files: $*"
- git add "$@"
- git commit -m "${COMMIT_MSG}"
-
- debug "Creating branch remotely"
- git push origin "${TEMP_BRANCH}"
-}
-
-function create_pr() {
- debug "Creating PR against ${BRANCH} branch"
- NEW_PR_URL=$(gh pr create --title "${PR_TITLE}" --body "${PR_BODY}: ${WORKFLOW_URL}" --base "${BRANCH}") # e.g, https://github.com/awslabs/aws-lambda-powertools/pull/13
-
- # greedy remove any string until the last URL path, including the last '/'. https://opensource.com/article/17/6/bash-parameter-expansion
- NEW_PR_ID="${NEW_PR_URL##*/}" # 13
- export NEW_PR_URL
- export NEW_PR_ID
-}
-
-function close_duplicate_prs() {
- debug "Do we have any duplicate PRs?"
- DUPLICATE_PRS=$(gh pr list --search "${PR_TITLE}" --json number --jq ".[] | select(.number != ${NEW_PR_ID}) | .number") # e.g, 13\n14
-
- debug "Closing duplicated PRs if any"
- echo "${DUPLICATE_PRS}" | xargs -L1 gh pr close --delete-branch --comment "Superseded by #${NEW_PR_ID}"
- export readonly DUPLICATE_PRS
-}
-
-function report_summary() {
- debug "Creating job summary"
- echo "### Pull request created successfully :rocket: #${NEW_PR_URL}
Closed duplicated PRs (if any): ${DUPLICATE_PRS}" >>"$GITHUB_STEP_SUMMARY"
-
- notice "PR_URL is ${NEW_PR_URL}"
- notice "PR_BRANCH is ${TEMP_BRANCH}"
- notice "PR_DUPLICATES are ${DUPLICATE_PRS}"
-}
-
-function main() {
- # Sanity check
- has_anything_changed
- has_required_config
-
- create_temporary_branch_with_changes "$@"
- create_pr
- close_duplicate_prs
-
- report_summary
-}
-
-main "$@"
diff --git a/.github/workflows/build_changelog.yml b/.github/workflows/build_changelog.yml
index ebc978022bc..f15275d07a7 100644
--- a/.github/workflows/build_changelog.yml
+++ b/.github/workflows/build_changelog.yml
@@ -3,17 +3,9 @@ name: Build changelog
on:
workflow_dispatch:
- schedule:
- # ┌───────────── minute (0 - 59)
- # │ ┌───────────── hour (0 - 23)
- # │ │ ┌───────────── day of the month (1 - 31)
- # │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
- # │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
- # │ │ │ │ │
- # │ │ │ │ │
- # │ │ │ │ │
- # * * * * *
- - cron: '0 8 * * *'
+ push:
+ branches:
+ - develop
jobs:
changelog:
diff --git a/.github/workflows/reusable_publish_changelog.yml b/.github/workflows/reusable_publish_changelog.yml
index 4294dda4a94..f08b23ca9f1 100644
--- a/.github/workflows/reusable_publish_changelog.yml
+++ b/.github/workflows/reusable_publish_changelog.yml
@@ -4,7 +4,9 @@ on:
workflow_call:
env:
- BRANCH: develop
+ TEMP_BRANCH_PREFIX: "ci-changelog"
+ PULL_REQUEST_TITLE: "chore(ci): changelog rebuild"
+ FILES_TO_COMMIT: "CHANGELOG.md"
jobs:
publish_changelog:
@@ -21,25 +23,13 @@ jobs:
uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
with:
fetch-depth: 0
- - name: Git client setup and refresh tip
- run: |
- git config user.name "Release bot"
- git config user.email "aws-devax-open-source@amazon.com"
- git config pull.rebase true
- git config remote.origin.url >&- || git remote add origin https://github.com/"${origin}" # Git Detached mode (release notes) doesn't have origin
- git pull origin "${BRANCH}"
- name: "Generate latest changelog"
run: make changelog
- name: Create PR
- run: bash .github/scripts/create_pr_for_staged_changes.sh CHANGELOG.md
- env:
- COMMIT_MSG: "chore(ci): update changelog with latest changes"
- PR_TITLE: "chore(ci): changelog rebuild"
- TEMP_BRANCH_PREFIX: "ci-changelog"
- GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- - name: Cleanup orphaned branch
- if: failure()
- run: git push origin --delete "${TEMP_BRANCH_PREFIX}-${GITHUB_RUN_ID}" || echo "Must have failed before creating temporary branch; no cleanup needed."
- env:
- TEMP_BRANCH_PREFIX: "ci-changelog"
- GITHUB_RUN_ID: ${{ github.run_id }}
+ id: create-pr
+ uses: ./.github/actions/create-pr
+ with:
+ files: ${{ env.FILES_TO_COMMIT }}
+ temp_branch_prefix: ${{ env.TEMP_BRANCH_PREFIX }}
+ pull_request_title: ${{ env.PULL_REQUEST_TITLE }}
+ github_token: ${{ secrets.GITHUB_TOKEN }}