Skip to content

Commit 34966dc

Browse files
dreamorosisvozza
dreamorosi
and
svozza
authored
ci: release workflows (#63)
Co-authored-by: Stefano Vozza <[email protected]>
1 parent 84bc3a5 commit 34966dc

File tree

10 files changed

+688
-18
lines changed

10 files changed

+688
-18
lines changed

‎.github/actions/create-pr/action.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: "Create PR custom action"
2+
description: "Create a PR and a temporary branch, close duplicates"
3+
4+
# PROCESS
5+
#
6+
# 1. Setup git client using Powertools for AWS Lambda bot username
7+
# 2. Pushes staged files to a temporary branch
8+
# 3. Creates a PR from temporary branch against a target branch (typically trunk: develop, main, etc.)
9+
# 4. Searches for duplicate PRs with the same title
10+
# 5. If duplicates are found, link to the most recent one, close and delete their branches so we keep a single PR
11+
# 6. In the event of failure, we delete the now orphaned branch (if any), and propagate the failure
12+
13+
# REQUIREMENTS
14+
# You need to enable "Allow GitHub Actions to create and approve pull requests" in your repository settings
15+
# You need to have "skip-changelog" label in your repository to skip changelog generation.
16+
17+
# USAGE
18+
#
19+
# - name: Create PR
20+
# id: create-pr
21+
# uses: ./.github/actions/create-pr
22+
# with:
23+
# files: "CHANGELOG.md"
24+
# temp_branch_prefix: "ci-changelog"
25+
# pull_request_title: "chore(ci): changelog rebuild"
26+
# github_token: ${{ secrets.GITHUB_TOKEN }}
27+
# - name: Step to demonstrate how to access outputs (no need for this)
28+
# run: |
29+
# echo "PR number: ${PR_ID}"
30+
# echo "Branch: ${BRANCH}"
31+
# env:
32+
# PR_ID: ${{ steps.create-pr.outputs.pull_request_id}}
33+
# BRANCH: ${{ steps.create-pr.outputs.temp_branch}}
34+
35+
inputs:
36+
files:
37+
description: "Files to add separated by space"
38+
required: true
39+
temp_branch_prefix:
40+
description: "Prefix for temporary git branch to be created, e.g, ci-docs"
41+
required: true
42+
pull_request_title:
43+
description: "Pull Request title to use"
44+
required: true
45+
github_token:
46+
description: "GitHub token for GitHub CLI"
47+
required: true
48+
target_branch:
49+
description: "Branch to target when creating a PR against (main, by default)"
50+
required: false
51+
default: main
52+
53+
outputs:
54+
pull_request_id:
55+
description: "Pull request ID created"
56+
value: ${{ steps.create-pr.outputs.pull_request_id }}
57+
temp_branch:
58+
description: "Temporary branch created with staged changed"
59+
value: ${{ steps.create-pr.outputs.temp_branch }}
60+
61+
runs:
62+
using: "composite"
63+
steps:
64+
- id: adjust-path
65+
run: echo "${{ github.action_path }}" >> $GITHUB_PATH
66+
shell: bash
67+
- id: setup-git
68+
name: Git client setup and refresh tip
69+
run: |
70+
git config --global user.name 'aws-powertools-bot'
71+
git config --global user.email '[email protected]'
72+
git config pull.rebase true
73+
git config remote.origin.url >&-
74+
shell: bash
75+
- id: create-pr
76+
working-directory: ${{ env.GITHUB_WORKSPACE }}
77+
run: create_pr_for_staged_changes.sh "${FILES}"
78+
env:
79+
FILES: ${{ inputs.files }}
80+
TEMP_BRANCH_PREFIX: ${{ inputs.temp_branch_prefix }}
81+
PR_TITLE: ${{ inputs.pull_request_title }}
82+
BASE_BRANCH: ${{ inputs.target_branch }}
83+
GH_TOKEN: ${{ inputs.github_token }}
84+
shell: bash
85+
- id: cleanup
86+
name: Cleanup orphaned branch
87+
if: failure()
88+
run: git push origin --delete "${TEMP_BRANCH_PREFIX}-${GITHUB_RUN_ID}" || echo "Must have failed before creating temporary branch; no cleanup needed."
89+
env:
90+
TEMP_BRANCH_PREFIX: ${{ inputs.temp_branch_prefix }}
91+
GITHUB_RUN_ID: ${{ github.run_id }}
92+
shell: bash

‎.github/actions/create-pr/create_pr_for_staged_changes.sh‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
#!/bin/bash
2+
set -uo pipefail # prevent accessing unset env vars, prevent masking pipeline errors to the next command
3+
4+
#docs
5+
#title :create_pr_for_staged_changes.sh
6+
#description :This script will create a PR for staged changes, detect and close duplicate PRs. All PRs will be omitted from Release Notes and Changelogs
7+
#author :@heitorlessa
8+
#date :May 8th 2023
9+
#version :0.1
10+
#usage :bash create_pr_for_staged_changes.sh {git_staged_files_or_directories_separated_by_space}
11+
#notes :Meant to use in GitHub Actions only. Temporary branch will be named $TEMP_BRANCH_PREFIX-$GITHUB_RUN_ID
12+
#os_version :Ubuntu 22.04.2 LTS
13+
#required_env_vars :PR_TITLE, TEMP_BRANCH_PREFIX, GH_TOKEN
14+
#==============================================================================
15+
16+
# Sets GitHub Action with error message to ease troubleshooting
17+
function error() {
18+
echo "::error file=${FILENAME}::$1"
19+
exit 1
20+
}
21+
22+
function debug() {
23+
TIMESTAMP=$(date -u "+%FT%TZ") # 2023-05-10T07:53:59Z
24+
echo ""${TIMESTAMP}" - $1"
25+
}
26+
27+
function notice() {
28+
echo "::notice file=${FILENAME}::$1"
29+
}
30+
31+
function start_span() {
32+
echo "::group::$1"
33+
}
34+
35+
function end_span() {
36+
echo "::endgroup::"
37+
}
38+
39+
function has_required_config() {
40+
start_span "Validating required config"
41+
test -z "${TEMP_BRANCH_PREFIX}" && error "TEMP_BRANCH_PREFIX env must be set to create a PR"
42+
test -z "${PR_TITLE}" && error "PR_TITLE env must be set"
43+
test -z "${GH_TOKEN}" && error "GH_TOKEN env must be set for GitHub CLI"
44+
45+
# Default GitHub Actions Env Vars: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
46+
debug "Are we running in GitHub Action environment?"
47+
test -z "${GITHUB_RUN_ID}" && error "GITHUB_RUN_ID env must be set to trace Workflow Run ID back to PR"
48+
test -z "${GITHUB_SERVER_URL}" && error "GITHUB_SERVER_URL env must be set to trace Workflow Run ID back to PR"
49+
test -z "${GITHUB_REPOSITORY}" && error "GITHUB_REPOSITORY env must be set to trace Workflow Run ID back to PR"
50+
51+
debug "Config validated successfully!"
52+
set_environment_variables
53+
end_span
54+
}
55+
56+
function set_environment_variables() {
57+
start_span "Setting environment variables"
58+
export readonly WORKFLOW_URL="${GITHUB_SERVER_URL}"/"${GITHUB_REPOSITORY}"/actions/runs/"${GITHUB_RUN_ID}" # e.g., heitorlessa/aws-lambda-powertools-test/actions/runs/4913570678
59+
export readonly TEMP_BRANCH="${TEMP_BRANCH_PREFIX}"-"${GITHUB_RUN_ID}" # e.g., ci-changelog-4894658712
60+
export readonly BASE_BRANCH="${BASE_BRANCH:-main}" # e.g., main, defaults to develop if missing
61+
export readonly PR_BODY="This is an automated PR created from the following workflow"
62+
export readonly FILENAME=".github/scripts/$(basename "$0")"
63+
export readonly NO_DUPLICATES_MESSAGE="No duplicated PRs found"
64+
export readonly SKIP_LABEL="skip-changelog"
65+
66+
end_span
67+
}
68+
69+
function has_anything_changed() {
70+
start_span "Validating git staged files"
71+
HAS_ANY_SOURCE_CODE_CHANGED="$(git status --porcelain)"
72+
73+
test -z "${HAS_ANY_SOURCE_CODE_CHANGED}" && debug "Nothing to update; exitting early" && exit 0
74+
end_span
75+
}
76+
77+
function create_temporary_branch_with_changes() {
78+
start_span "Creating temporary branch: "${TEMP_BRANCH}""
79+
git checkout -b "${TEMP_BRANCH}"
80+
81+
debug "Committing staged files: $*"
82+
echo "$@" | xargs -n1 git add || error "Failed to add staged changes: "$@""
83+
git commit -m "${PR_TITLE}"
84+
85+
git push origin "${TEMP_BRANCH}" || error "Failed to create new temporary branch"
86+
end_span
87+
}
88+
89+
function create_pr() {
90+
start_span "Creating PR against ${TEMP_BRANCH} branch"
91+
# TODO: create label
92+
NEW_PR_URL=$(gh pr create --title "${PR_TITLE}" --body "${PR_BODY}: ${WORKFLOW_URL}" --base "${BASE_BRANCH}" --label "${SKIP_LABEL}" || error "Failed to create PR") # e.g, https://github.com/aws-powertools/powertools-lambda-python/pull/13
93+
94+
# greedy remove any string until the last URL path, including the last '/'. https://opensource.com/article/17/6/bash-parameter-expansion
95+
debug "Extracing PR Number from PR URL: "${NEW_PR_URL}""
96+
NEW_PR_ID="${NEW_PR_URL##*/}" # 13
97+
export NEW_PR_URL
98+
export NEW_PR_ID
99+
end_span
100+
}
101+
102+
function close_duplicate_prs() {
103+
start_span "Searching for duplicate PRs"
104+
DUPLICATE_PRS=$(gh pr list --search "${PR_TITLE}" --json number --jq ".[] | select(.number != ${NEW_PR_ID}) | .number") # e.g, 13\n14
105+
106+
if [ -z "${DUPLICATE_PRS}" ]; then
107+
debug "No duplicate PRs found"
108+
DUPLICATE_PRS="${NO_DUPLICATES_MESSAGE}"
109+
else
110+
debug "Closing duplicated PRs: "${DUPLICATE_PRS}""
111+
echo "${DUPLICATE_PRS}" | xargs -L1 gh pr close --delete-branch --comment "Superseded by #${NEW_PR_ID}"
112+
fi
113+
114+
export readonly DUPLICATE_PRS
115+
end_span
116+
}
117+
118+
function report_job_output() {
119+
start_span "Updating job outputs"
120+
echo pull_request_id="${NEW_PR_ID}" >>"$GITHUB_OUTPUT"
121+
echo temp_branch="${TEMP_BRANCH}" >>"$GITHUB_OUTPUT"
122+
end_span
123+
}
124+
125+
function report_summary() {
126+
start_span "Creating job summary"
127+
echo "### Pull request created successfully :rocket: ${NEW_PR_URL} <br/><br/> Closed duplicated PRs: ${DUPLICATE_PRS}" >>"$GITHUB_STEP_SUMMARY"
128+
129+
notice "PR_URL is: ${NEW_PR_URL}"
130+
notice "PR_BRANCH is: ${TEMP_BRANCH}"
131+
notice "PR_DUPLICATES are: ${DUPLICATE_PRS}"
132+
end_span
133+
}
134+
135+
function main() {
136+
# Sanity check
137+
has_anything_changed
138+
has_required_config
139+
140+
create_temporary_branch_with_changes "$@"
141+
create_pr
142+
close_duplicate_prs
143+
144+
report_job_output
145+
report_summary
146+
}
147+
148+
main "$@"

‎.github/workflows/make-release.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Make Release
2+
3+
# RELEASE PROCESS
4+
#
5+
# === Automated activities ===
6+
# 1. [Quality check] run unit tests and linting
7+
# 2. [Release] publish package to npmjs.org using the latest git commit, ensure provenance with NPM_CONFIG_PROVENANCE=true
8+
# 3. [Create tag] create a new git tag using released version, i.e. v1.13.1
9+
#
10+
# === Manual activities ===
11+
# 1. Kick off `make-version` workflow to bump and review the version changes and changelog for each package
12+
# 2. Merge the PR created by `make-version` workflow
13+
# 3. Kick off this workflow to make the release
14+
# 4. Update draft release notes with the latest changes and publish the release on GitHub
15+
16+
on:
17+
workflow_dispatch: {}
18+
19+
permissions:
20+
contents: read
21+
22+
concurrency:
23+
group: on-release-publish
24+
25+
26+
jobs:
27+
# temporarily disabled until we address #48
28+
# run-unit-tests:
29+
# uses: ./.github/workflows/reusable-code-quality.yml
30+
# This job publishes the packages to npm.
31+
# It uses the latest git commit sha as the version and ensures provenance with NPM_CONFIG_PROVENANCE flag.
32+
# We don't bump the version because we do that in the `make-version` workflow.
33+
# It also sets the RELEASE_VERSION output to be used by the next job to create a git tag.
34+
publish-npm:
35+
# needs: run-unit-tests // uncomment when we re-enable the unit tests #48
36+
# Needed as recommended by npm docs on publishing with provenance https://docs.npmjs.com/generating-provenance-statements
37+
permissions:
38+
id-token: write
39+
environment: Release
40+
runs-on: ubuntu-latest
41+
outputs:
42+
RELEASE_VERSION: ${{ steps.set-release-version.outputs.RELEASE_VERSION }}
43+
steps:
44+
- name: Checkout code
45+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
46+
with:
47+
ref: ${{ github.sha }}
48+
- name: Setup Node.js
49+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
50+
with:
51+
node-version: "22"
52+
cache: "npm"
53+
- name: Setup auth tokens
54+
run: |
55+
npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
56+
- name: Setup dependencies
57+
uses: aws-powertools/actions/.github/actions/cached-node-modules@29979bc5339bf54f76a11ac36ff67701986bb0f0
58+
- name: Publish to npm
59+
run: |
60+
NPM_CONFIG_PROVENANCE=true npm publish
61+
- name: Set release version
62+
id: set-release-version
63+
run: |
64+
VERSION=$(cat lerna.json | jq .version -r)
65+
echo RELEASE_VERSION="$VERSION" >> "$GITHUB_OUTPUT"
66+
67+
# This job creates a new git tag using the released version (v1.18.1)
68+
create_tag:
69+
needs: [publish-npm]
70+
permissions:
71+
contents: write
72+
runs-on: ubuntu-latest
73+
steps:
74+
- name: Checkout code
75+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
76+
with:
77+
ref: ${{ github.sha }}
78+
- name: Git client setup
79+
run: |
80+
git config --global user.name 'aws-powertools-bot'
81+
git config --global user.email '[email protected]'
82+
git config remote.origin.url >&-
83+
- name: Create git tag
84+
run : |
85+
git tag -a v${{ needs.publish-npm.outputs.RELEASE_VERSION }} -m "Release v${{ needs.publish-npm.outputs.RELEASE_VERSION }}"
86+
git push origin v${{ needs.publish-npm.outputs.RELEASE_VERSION }}

‎.github/workflows/make-version.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Make Version
2+
3+
on:
4+
workflow_dispatch: { }
5+
6+
permissions:
7+
contents: read
8+
9+
10+
jobs:
11+
bump-version:
12+
permissions:
13+
id-token: write
14+
contents: write
15+
pull-requests: write
16+
runs-on: ubuntu-latest
17+
outputs:
18+
RELEASE_VERSION: ${{ steps.set-release-version.outputs.RELEASE_VERSION }}
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
22+
with:
23+
ref: ${{ github.ref }}
24+
fetch-depth: 0 # fetch all history, commits and tags, lerna scans it to the last tag and looks at commits, we need all of it to determine the next version
25+
- name: Setup Node.js
26+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
27+
with:
28+
node-version: "22"
29+
cache: "npm"
30+
- name: Setup dependencies
31+
uses: aws-powertools/actions/.github/actions/cached-node-modules@29979bc5339bf54f76a11ac36ff67701986bb0f0
32+
- name: Version
33+
id: bump-version
34+
run: npx changelogen --bump --no-commit --no-push --noAuthors
35+
- name: Update version in lock file
36+
run: npm update --package-lock-only
37+
- name: Update user agent version
38+
run: |
39+
VERSION=$(cat package.json | jq .version -r)
40+
echo -e "// this file is auto generated, do not modify\nexport const VERSION = '$VERSION';" > src/version.ts
41+
- name: Stage changes
42+
run: git add .
43+
- name: Set release version
44+
id: set-release-version
45+
run: |
46+
VERSION=$(cat package.json | jq .version -r)
47+
echo RELEASE_VERSION="$VERSION" >> "$GITHUB_OUTPUT"
48+
- name: Create PR
49+
id: create-pr
50+
uses: ./.github/actions/create-pr
51+
with:
52+
temp_branch_prefix: "ci-bump"
53+
pull_request_title: "chore: bump version to ${{ steps.set-release-version.outputs.RELEASE_VERSION }}"
54+
github_token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)