Skip to content

chore(ci): refactor release workflow #2028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions .github/workflows/make-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,47 @@ jobs:
- name: Checkout code
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
# Here `token` is needed to avoid incurring in error GH006 Protected Branch Update Failed,
token: ${{ secrets.GH_PUBLISH_TOKEN }}
# While `fetch-depth` is used to allow the workflow to later commit & push the changes.
fetch-depth: 0
ref: ${{ github.sha }}
- name: Setup NodeJS
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
node-version: "20"
cache: "npm"
- name: Setup auth tokens
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git remote set-url origin https://x-access-token:${{ secrets.GH_PUBLISH_TOKEN }}@github.com/$GITHUB_REPOSITORY
npm set "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}"
- name: Setup dependencies
uses: ./.github/actions/cached-node-modules
- name: Version
run: |
npx lerna version minor --force-publish --no-commit-hooks --yes
- name: Publish to npm
run: |
NPM_CONFIG_PROVENANCE=true npx lerna publish from-git --yes
NPM_CONFIG_PROVENANCE=true npx lerna publish from-package --git-head ${{ github.sha }} --yes
- name: Set release version
id: set-release-version
run: |
VERSION=$(cat lerna.json | jq .version -r)
echo RELEASE_VERSION="$VERSION" >> "$GITHUB_OUTPUT"


create_tag:
needs: [publish-npm]
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
token: ${{ secrets.GH_PUBLISH_TOKEN }}
ref: ${{ github.sha }}
- name: Git client setup
run: |
git config --global user.name 'aws-powertools-bot'
git config --global user.email '[email protected]'
git config remote.origin.url >&-
- name: Create git tag
run : |
git tag -a v${{ needs.publish-npm.outputs.RELEASE_VERSION }} -m "Release v${{ needs.publish-npm.outputs.RELEASE_VERSION }}"
git push origin v${{ needs.publish-npm.outputs.RELEASE_VERSION }}

# NOTE: Watch out for the depth limit of 4 nested workflow_calls.
# publish_layer -> reusable_deploy_layer_stack -> reusable_update_layer_arn_docs
publish_layer:
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/make-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ on:
workflow_dispatch: { }


env:
RELEASE_COMMIT: ${{ github.sha }}

jobs:
bump-version:
permissions:
Expand All @@ -20,7 +17,7 @@ jobs:
- name: Checkout code
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
ref: ${{ github.ref }}
ref: ${{ github.sha }}
- name: Setup NodeJS
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish_layer.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy layer to all regions

permissions:
contents: write
contents: read

on:
# Manual trigger
Expand Down Expand Up @@ -33,7 +33,7 @@ jobs:
- name: checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
fetch-depth: 0
ref: ${{ github.sha }}
- name: Setup Node.js
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
with:
Expand Down
32 changes: 15 additions & 17 deletions .github/workflows/reusable_update_layer_arn_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
required: true

permissions:
contents: write
contents: read

env:
BRANCH: main
Expand All @@ -21,18 +21,15 @@ jobs:
concurrency:
group: changelog-build
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
id-token: none
steps:
- name: Checkout repository # reusable workflows start clean, so we need to checkout again
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
fetch-depth: 0
- name: Git client setup and refresh tip
run: |
git config user.name "Release bot[bot]"
git config user.email "[email protected]"
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}"
ref: ${{ github.sha }}
- name: Download CDK layer artifact
uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935 # v4.1.1
with:
Expand All @@ -42,11 +39,12 @@ jobs:
run: |
ls -la cdk-layer-stack/
./.github/scripts/update_layer_arn.sh cdk-layer-stack
- name: Update documentation in trunk
run: |
HAS_CHANGE=$(git status --porcelain)
test -z "${HAS_CHANGE}" && echo "Nothing to update" && exit 0
git add docs/index.md
git commit -m "chore: update layer ARN on documentation"
git pull origin "${BRANCH}" # prevents concurrent branch update failing push
git push origin HEAD:refs/heads/"${BRANCH}"
- name: Create PR
id: create-pr
uses: ./.github/actions/create-pr
with:
files: 'docs/index.md'
temp_branch_prefix: 'ci-layer-docs'
pull_request_title: 'chore(ci): update layer ARN on documentation'
github_token: ${{ secrets.GITHUB_TOKEN }}