Skip to content
This repository has been archived by the owner on Dec 12, 2024. It is now read-only.

Commit

Permalink
Issue #97: Create Release workflow:
Browse files Browse the repository at this point in the history
* Accepts input of release version
* Tags as "v$releaseVersion"
* Publishes Kotlin binary to TBD Artifactory
* Publishes Kotlin binary to Maven Central
  • Loading branch information
ALRubinger committed Aug 2, 2024
1 parent 074cf3a commit 3ec3bd1
Show file tree
Hide file tree
Showing 3 changed files with 193 additions and 7 deletions.
24 changes: 17 additions & 7 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,19 @@ on:
workflow_dispatch:
inputs:
version:
description: 'Version of Kotlin binary to publish to TBD Artifactory. For example "1.0.0-SNAPSHOT". If not supplied, will default to version specified in the POM. Must end in "-SNAPSHOT".'
description: 'Version of Kotlin binary to publish to TBD Artifactory. For example "1.0.0-SNAPSHOT". If not supplied, will default to "commit-$shortSHA-SNAPSHOT" where $shortSHA is the shortform commit SHA. Must end in "-SNAPSHOT".'
required: false
default: "0.0.0-SNAPSHOT"
push:
branches:
- main
pull_request:
workflow_call:
inputs:
version:
description: 'Version of Kotlin binary to publish to TBD Artifactory. For example "1.0.0-SNAPSHOT". If not supplied, will default to "commit-$shortSHA-SNAPSHOT" where $shortSHA is the shortform commit SHA. Must end in "-SNAPSHOT".'
required: true
type: string

env:
CARGO_TERM_COLOR: always
Expand Down Expand Up @@ -111,6 +117,14 @@ jobs:
distribution: "adopt"
java-version: "11"

# Cache Maven repo
- uses: actions/cache@v3
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Resolve Snapshot Version
id: resolve_version
run: |
Expand All @@ -125,15 +139,11 @@ jobs:
echo "Requesting deployment as version: $resolvedVersion"
fi
# Postcondition check; only allow this to proceed if we have a version ending in "-SNAPSHOT"
if [[ ! "$resolvedVersion" =~ -SNAPSHOT$ ]]; then
echo "Error: The version does not end with \"-SNAPSHOT\": $resolvedVersion"
exit 1
fi
echo "Resolved SNAPSHOT Version: $resolvedVersion"
echo "resolved_version=$resolvedVersion" >> $GITHUB_OUTPUT
# Package up the native binaries
#TODO Centralize this block as we re-use it via copy/paste right now
- name: Download MacOS aarch64 Native Library
uses: actions/[email protected]
with:
Expand Down
174 changes: 174 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
name: Release

on:
workflow_dispatch:
inputs:
version:
description: 'Version of tbDEX to release and publish to TBD Artifactory and Maven Central. For example "1.0.0" or "1.3.7-beta-2". Required. Must not end in "-SNAPSHOT".'
required: true

jobs:

run-ci:
# This will run CI and also publish the Kotlin release to the TBD Artifactory repo manager
name: Run CI
uses: TBD54566975/tbdex-rs/.github/workflows/ci.yml@main
secrets: inherit
with:
version: ${{ github.event.inputs.version }}

git-tag:
runs-on: ubuntu-latest
needs: run-ci
outputs:
RELEASE_TAG: ${{ steps.set-version-and-tag.outputs.RELEASE_TAG }}
RELEASE_VERSION: ${{ steps.set-version-and-tag.outputs.RELEASE_VERSION }}

name: Create Git Tag
steps:
- id: checkout
uses: actions/checkout@v4
with:
submodules: true
token: ${{ secrets.TBD_RELEASE_GITHUB_PERSONAL_ACCESS_TOKEN }}

# Used in writing commits in the release process
- id: set-git-config
name: Set Git Config
run: |
git config user.name "tbd-releases"
git config user.email "[email protected]"
# Cache Maven repo
- id: cache
uses: actions/cache@v3
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- id: set-version-and-tag
name: Set version of Kotlin and commit
run: |
# cd into the Kotlin project
cd bound/kt/
# Get the required provided version
version=${{ github.event.inputs.version }}
# Precondition check; do not allow this to proceed if a version ending in "-SNAPSHOT" was specified
if [[ $version =~ -SNAPSHOT$ ]]; then
echo "Error: The version for release must not end with \"-SNAPSHOT\": $version"
exit 1
fi
# Get the existing version from the POM and set it to the nextVersion, keeping the POM effectively versionless
nextVersion=$(grep -oPm1 "(?<=<version>)[^<]+" pom.xml)
if [[ -z $nextVersion ]]; then
echo "Error: Could not find a version in the pom.xml"
exit 1
fi
echo "Version to be released: $version"
echo "Setting next development version back to original in pom.xml: $nextVersion"
# Set newly resolved version in POM config
mvn \
versions:set \
--batch-mode \
-DnewVersion=$version
# Commit
git add -Av
git commit -m "[TBD Release Manager 🚀] Setting version to: $version"
tagName=v$version
git tag -a $tagName -m "Tag version: $tagName" # We tag with a prefix of "v"
git push origin main
git push origin $tagName
# Make the version and tag name available to subsequent jobs as an output param
echo "RELEASE_TAG=$tagName" >> "$GITHUB_OUTPUT"
echo "RELEASE_VERSION=$version" >> "$GITHUB_OUTPUT"
cat $GITHUB_OUTPUT
# Set the next development version and commit
mvn \
versions:set \
--batch-mode \
-DnewVersion=$nextVersion
git add -Av
git commit -m "[TBD Release Manager 🚀] Setting next development version after $version to: $nextVersion"
git push origin main
kotlin-release-to-tbd-artifactory-and-maven-central:
name: Release Kotlin to Maven Central
needs: git-tag
runs-on: ubuntu-latest
steps:

# Check out the tag we created above
- uses: actions/checkout@v4
with:
submodules: true
ref: ${{ needs.git-tag.outputs.RELEASE_TAG }} # Check out the tag we created above

# Set up JDK
- name: Set up JDK 11
uses: actions/setup-java@v3
with:
distribution: "adopt"
java-version: "11"

# Cache Maven repo
- uses: actions/cache@v3
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
# Package up the native binaries
#TODO Centralize this block as we re-use it via copy/paste right now
- name: Download MacOS aarch64 Native Library
uses: actions/[email protected]
with:
name: aarch64-apple-darwin-dylib
path: bound/kt/src/main/resources/
- name: Download MacOS x86_64 Native Library
uses: actions/[email protected]
with:
name: x86_64-apple-darwin-dylib
path: bound/kt/src/main/resources/
- name: Download Linux x86_64 GNU Native Library
uses: actions/[email protected]
with:
name: x86_64-unknown-linux-gnu-so
path: bound/kt/src/main/resources/
- name: Download Linux x86_64 MUSL Native Library
uses: actions/[email protected]
with:
name: x86_64-unknown-linux-musl-so
path: bound/kt/src/main/resources/

- name: Deploy Release Version of Kotlin Project to Maven Central
run: |
# cd into the Kotlin project
cd bound/kt/
# Publish to Sonatype
# Precondition check: Only attempt to publish artifact if we have credentials
if [ -n "${{ secrets.SONATYPE_PASSWORD }}" ]; then
# Maven deploy lifecycle will build, run tests, verify, sign, and deploy
mvn deploy --batch-mode \
--settings .maven_settings.xml \
-P ossrh,sign-artifacts
else
echo "Error: No credentials"
exit 1
fi
env:
SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
SIGN_KEY_PASS: ${{ secrets.GPG_SECRET_PASSPHRASE }}
SIGN_KEY: ${{ secrets.GPG_SECRET_KEY }}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ bound/kt/src/main/resources/*.so
# .class file for acceptance test
tests/jvm/**.class

# Do not commit versionBackup files
**/pom.xml.versionsBackup

# ---

Expand Down

0 comments on commit 3ec3bd1

Please sign in to comment.