-
Notifications
You must be signed in to change notification settings - Fork 22
chore(go): add Go release workflow #792
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
Open
rishav-karanjit
wants to merge
25
commits into
mainline
Choose a base branch
from
rishav/releaseScript
base: mainline
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 13 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
a33ef8d
auto commit
rishav-karanjit a3303aa
auto commit
rishav-karanjit 34191df
auto commit
rishav-karanjit 8b1b50d
auto commit
rishav-karanjit ba0278e
auto commit
rishav-karanjit 121bb63
auto commit
rishav-karanjit a5de953
auto commit
rishav-karanjit 17f4391
Merge branch 'mainline' into rishav/releaseScript
rishav-karanjit dc8148c
auto commit
rishav-karanjit 2aa6b79
Merge branch 'rishav/releaseScript' of https://github.com/aws/aws-enc…
rishav-karanjit c286938
auto commit
rishav-karanjit 3d8b53a
Merge branch 'mainline' into rishav/releaseScript
rishav-karanjit bda38cc
auto commit
rishav-karanjit 5ce2fd5
Update scripts/go-release-automation.sh
rishav-karanjit a3283aa
auto commit
rishav-karanjit 5f61571
auto commit
rishav-karanjit 7acd6e8
bump mpl
rishav-karanjit cbc1fd8
Merge branch 'mainline' into rishav/releaseScript
rishav-karanjit 2cd5321
auto commit
rishav-karanjit dd2aba1
Merge branch 'rishav/releaseScript' of https://github.com/aws/aws-enc…
rishav-karanjit 027cecd
Update go-release.yml
rishav-karanjit 5d2ab3b
Update project.properties
rishav-karanjit 2141441
auto commit
rishav-karanjit 1732e95
formatting
rishav-karanjit ca235ca
bump mpl
rishav-karanjit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
name: Go Release Automation | ||
|
||
on: | ||
workflow_dispatch: | ||
inputs: | ||
project-name: | ||
description: "Project name (e.g., AwsEncryptionSDK)" | ||
required: true | ||
type: string | ||
version: | ||
description: "Version (e.g., v0.1.0)" | ||
required: true | ||
type: string | ||
|
||
jobs: | ||
get-dafny-version: | ||
uses: ./.github/workflows/dafny_version.yaml | ||
|
||
go-release: | ||
needs: get-dafny-version | ||
runs-on: macos-13 | ||
permissions: | ||
contents: write | ||
pull-requests: write | ||
id-token: write | ||
|
||
steps: | ||
- name: Support longpaths on Git checkout | ||
run: | | ||
git config --global core.longpaths true | ||
|
||
- name: Configure AWS Credentials for Tests | ||
uses: aws-actions/configure-aws-credentials@v4 | ||
with: | ||
aws-region: us-west-2 | ||
role-to-assume: arn:aws:iam::370957321024:role/GitHub-CI-Public-ESDK-Dafny-Role-us-west-2 | ||
role-session-name: GoReleaseTest | ||
|
||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Update submodules | ||
run: | | ||
git submodule update --init --recursive | ||
|
||
- name: Setup Dafny | ||
uses: ./mpl/.github/actions/setup_dafny | ||
with: | ||
dafny-version: ${{ needs.get-dafny-version.outputs.version }} | ||
|
||
- name: Install Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version: "1.23" | ||
|
||
- name: Install Go imports | ||
run: | | ||
go install golang.org/x/tools/cmd/goimports@latest | ||
|
||
- name: Install Smithy-Dafny codegen dependencies | ||
uses: ./.github/actions/install_smithy_dafny_codegen_dependencies | ||
|
||
- name: Configure Git | ||
run: | | ||
git config --global user.name "GitHub Actions" | ||
git config --global user.email "[email protected]" | ||
|
||
- name: Get release directory name | ||
id: release-dir | ||
run: | | ||
chmod +x ./scripts/go-release-automation.sh | ||
RELEASE_DIR_NAME=$(./scripts/go-release-automation.sh get_release_dir_name "${{ github.event.inputs.project-name }}" "${{ github.event.inputs.version }}") | ||
echo "releaseDirName=$RELEASE_DIR_NAME" >> $GITHUB_OUTPUT | ||
|
||
- name: Generate a changelog | ||
uses: orhun/git-cliff-action@v4 | ||
with: | ||
config: releases/go/.git-cliff.toml | ||
args: --bump -u --prepend releases/go/${{ steps.release-dir.outputs.releaseDirName }}/CHANGELOG.md | ||
|
||
- name: Run Go release automation script | ||
run: | | ||
./scripts/go-release-automation.sh run_release_script ${{ github.event.inputs.project-name }} ${{ github.event.inputs.version }} | ||
|
||
- name: Create Pull Request | ||
env: | ||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
PROJECT_NAME="${{ github.event.inputs.project-name }}" | ||
VERSION="${{ github.event.inputs.version }}" | ||
|
||
# Get the release directory name using the sourced function | ||
RELEASE_DIR_NAME="${{ steps.release-dir.outputs.releaseDirName }}" | ||
|
||
BRANCH_NAME="golang-release-staging-branch/$RELEASE_DIR_NAME/$VERSION" | ||
|
||
DIFF_FILES=$(diff -qr $PROJECT_NAME/runtimes/go/ImplementationFromDafny-go releases/go/$RELEASE_DIR_NAME || true) | ||
|
||
# Create PR using GitHub CLI | ||
gh pr create \ | ||
--title "chore(go): Release $RELEASE_DIR_NAME Go module $VERSION" \ | ||
--body "This PR was automatically created by the Go Release Automation workflow. It releases version $VERSION of the $RELEASE_DIR_NAME Go module. The diff between $PROJECT_NAME/runtimes/go/ImplementationFromDafny-go and releases/go/$RELEASE_DIR_NAME is below: | ||
|
||
$DIFF_FILES | ||
" \ | ||
--base main \ | ||
--head "$BRANCH_NAME" \ | ||
--label "golang" \ | ||
--draft |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
#!/bin/bash | ||
|
||
# Go Release Process Script | ||
# Used for copying go files to release directory and make a commit | ||
|
||
set -e # Exit on error | ||
|
||
# Check if project name and version is provided | ||
if [ $# -ne 3 ]; then | ||
echo "Usage: $0 <function> <project-name> [version]" | ||
echo "Example: $0 get_release_dir_name AwsEncryptionSDK v0.1.0" | ||
echo "Example: $0 run_release_script AwsEncryptionSDK v0.1.0" | ||
exit 1 | ||
fi | ||
|
||
# Function to map project name to release directory name | ||
get_release_dir_name() { | ||
local project=$1 | ||
case "$project" in | ||
"AwsEncryptionSDK") echo "encryption-sdk" ;; | ||
*) echo "Error: Unknown project name: $project" >&2; return 1 ;; | ||
esac | ||
} | ||
|
||
run_release_script() { | ||
PROJECT_NAME=$1 | ||
VERSION=$2 | ||
|
||
echo "Starting Go release script for $PROJECT_NAME $VERSION" | ||
|
||
# Pull the latest smithy-dafny and libraries git submodules | ||
echo " Pulling latest git submodules..." | ||
git submodule update --init --recursive | ||
|
||
# Go to the project directory | ||
echo " Navigating to $PROJECT_NAME..." | ||
cd "$PROJECT_NAME" || { echo "Error: Project directory $PROJECT_NAME not found"; exit 1; } | ||
|
||
# Build using make commands | ||
echo " Building project..." | ||
make polymorph_dafny | ||
make polymorph_go | ||
make transpile_go | ||
make test_go | ||
|
||
# Run Go tools in ImplementationFromDafny-go | ||
echo " Running Go tools in ImplementationFromDafny-go..." | ||
cd runtimes/go/ImplementationFromDafny-go || { echo "Error: ImplementationFromDafny-go directory not found"; exit 1; } | ||
|
||
find . -name "*shim.go" -type f -delete | ||
echo "Removed all shim.go files" | ||
|
||
run_go_tools | ||
|
||
# Replacement directives are removed to get package from go pkg instead of local copy | ||
echo "Removing all replace directives from go.mod..." | ||
go mod edit -json | jq -r '.Replace[].Old.Path' | xargs -n1 go mod edit -dropreplace | ||
|
||
# Get the mapped release directory name | ||
RELEASE_DIR_NAME=$(get_release_dir_name "$PROJECT_NAME") | ||
|
||
# Copy files to releases directory | ||
echo " Copying files to releases/go/$RELEASE_DIR_NAME..." | ||
|
||
# Use rsync to copy files while excluding following ones: | ||
# ImplementationFromDafny.go: This file is for devlopment. Users is expected use API(s) from `*/api_client.go` | ||
# ImplementationFromDafny-go.dtr: This is the dafny translation record only needed for code generation | ||
# go.sum: This files will be updated by go mod tidy | ||
rsync -av --exclude="ImplementationFromDafny.go" --exclude="ImplementationFromDafny-go.dtr" --exclude="go.sum" ./ "$(git rev-parse --show-toplevel)/releases/go/$RELEASE_DIR_NAME/" | ||
|
||
# copy examples | ||
cd ../examples | ||
echo "Removing all replace directives from go.mod and only adding replacement for ESDK" | ||
go mod edit -json | jq -r '.Replace[].Old.Path' | xargs -n1 go mod edit -dropreplace | ||
go mod edit -replace=github.com/aws/aws-encryption-sdk/releases/go/encryption-sdk=../ | ||
rsync -av --exclude="go.sum" ./ "$(git rev-parse --show-toplevel)/releases/go/$RELEASE_DIR_NAME/examples" | ||
|
||
# Run Go tools in releases directory | ||
echo "Running Go tools in releases/go/$RELEASE_DIR_NAME..." | ||
|
||
cd "$(git rev-parse --show-toplevel)/releases/go/$RELEASE_DIR_NAME/" || { echo "Error: releases directory not found"; exit 1; } | ||
run_go_tools | ||
|
||
echo "Running Go tools in releases/go/$RELEASE_DIR_NAME/examples" | ||
|
||
cd "$(git rev-parse --show-toplevel)/releases/go/$RELEASE_DIR_NAME/examples" || { echo "Error: examples directory not found"; exit 1; } | ||
run_go_tools | ||
go run main.go | ||
|
||
# Prepare for commit | ||
echo "creating a branch..." | ||
|
||
git checkout -b "golang-release-staging-branch/$RELEASE_DIR_NAME/${VERSION}" | ||
git add * | ||
|
||
git commit -m "Release $RELEASE_DIR_NAME Go module ${VERSION}" | ||
git push origin "golang-release-staging-branch/$RELEASE_DIR_NAME/${VERSION}" | ||
} | ||
|
||
run_go_tools() { | ||
echo "Running goimports..." | ||
goimports -w . | ||
echo "Running go get -u..." | ||
go get -u ./... | ||
|
||
echo "Running go mod tidy..." | ||
go mod tidy | ||
|
||
echo "Running go build to check for errors..." | ||
go build --gcflags="-e" ./... | ||
} | ||
|
||
"$@" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.