Setup Releases (#36)

Author: leordev

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      versionType:
+        description: "Version Type - Major, Minor, Patch, Manual"
+        required: true
+        default: patch
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+          - manual
+      customVersion:
+        description: "Custom Version - Use if Version Type is Manual"
+        required: false
+
+jobs:
+  release:
+    # validate if input was versionType = Major, Minor, Patch or Manual
+    # if its Manual we require the `customVersion` value
+    if: github.event.inputs.versionType != 'manual' || github.event.inputs.customVersion != null
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 100
+          fetch-tags: true
+
+      - name: Bump tag version
+        id: bump_version
+        run: |
+          VERSION_TYPE=${{ github.event.inputs.versionType }}
+          CUSTOM_VERSION=${{ github.event.inputs.customVersion }}
+          if [[ "$VERSION_TYPE" == "manual" && -n "$CUSTOM_VERSION" ]]; then
+            NEW_TAG=$CUSTOM_VERSION
+          elif [[ "$VERSION_TYPE" == "major" || "$VERSION_TYPE" == "minor" ||  "$VERSION_TYPE" == "patch" ]]; then
+            npm install -g semver
+            LAST_TAG=$(git describe --match "[0-9]*.[0-9]*.[0-9]*" --tags --abbrev=0)
+            NEW_TAG=$(semver -i $VERSION_TYPE $LAST_TAG)
+          else
+            echo "Invalid version type"
+            exit 1
+          fi
+          echo "New version: $NEW_TAG"
+          echo "new_tag=$NEW_TAG" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ steps.bump_version.outputs.new_tag }}
+          draft: false
+          prerelease: true
+          generate_release_notes: true

README.md

@@ -6,13 +6,46 @@
 
 > ⚠️ tbDEX SWIFT SDK IS CURRENTLY A WIP! ⚠️
 
-# Prerequisites
+## Prerequisites
 
-## Cloning
+### Cloning
 
 After cloning this repository, run:
+
 ```
 make bootstrap
 ```
 
 This will configure the repository's submodules properly, and ensure you're all set to go!
+
+## Release Guidelines
+
+### Pre-releases
+
+With Swift Package Manager, pre-releases are not necessary as it can directly utilize the repository's revision or branch name. For instance, to test the current version of the tbDEX package, you can specify either:
+
+```swift
+  // Use the main branch
+  .package(url: "https://github.com/TBD54566975/tbdex-swift.git", .branch("main")),
+
+  // Use a specific commit
+  .package(url: "https://github.com/TBD54566975/tbdex-swift.git", .revision("28b3c865742f3b0cb9813f84e9c547425a06ac1d")),
+```
+
+### Releasing New Versions
+
+To release a new version, initiate the `Release` workflow:
+
+1. Select the version type: `major`, `minor`, `patch`, or `manual`.
+
+   - For instance, if the latest version is `0.1.2`:
+     - `major` will update to `1.0.0`
+     - `minor` will update to `0.2.0`
+     - `patch` will update to `0.1.3`
+     - For `manual`, input the desired version in the Custom Version field, e.g., `0.9.0`
+
+2. The workflow will automatically create a git tag and a GitHub release, including an automated changelog.
+
+### Publishing Docs
+
+API reference documentation is automatically updated and available at [https://swiftpackageindex.com/TBD54566975/tbdex-swift/{latest-version}/documentation/tbdex](https://swiftpackageindex.com/TBD54566975/tbdex-swift/main/documentation/tbdex) following each release.