|
| 1 | +# A workflow for validating that release branch versions match the version in code |
| 2 | + |
| 3 | +name: Release Branch Version Check |
| 4 | + |
| 5 | +# Triggers the workflow when we push to a rel/* branch or create a tag |
| 6 | +on: |
| 7 | + push: |
| 8 | + branches: |
| 9 | + - 'rel/*' |
| 10 | + tags: |
| 11 | + - '*' |
| 12 | + |
| 13 | +jobs: |
| 14 | + version-check: |
| 15 | + name: Validate Release Branch Version |
| 16 | + runs-on: ubuntu-22.04 |
| 17 | + |
| 18 | + steps: |
| 19 | + - uses: actions/checkout@v4 |
| 20 | + |
| 21 | + # Extract version from branch name and Version.swift, then compare them |
| 22 | + - name: Validate Version Match |
| 23 | + id: validate_version_match |
| 24 | + run: | |
| 25 | + # Determine if this is a tag or branch push |
| 26 | + if [[ "${GITHUB_REF}" == refs/tags/* ]]; then |
| 27 | + VERSION_NAME="${GITHUB_REF#refs/tags/}" |
| 28 | + echo "Detected tag push: $VERSION_NAME" |
| 29 | + elif [[ "${GITHUB_REF}" == refs/heads/rel/* ]]; then |
| 30 | + BRANCH_NAME="${GITHUB_REF#refs/heads/}" |
| 31 | + if [[ $BRANCH_NAME =~ ^rel/(.+)$ ]]; then |
| 32 | + VERSION_NAME="${BASH_REMATCH[1]}" |
| 33 | + echo "Detected rel/* branch push: $VERSION_NAME" |
| 34 | + else |
| 35 | + ERROR_MESSAGE="Error: branch name does not match expected pattern" |
| 36 | + echo "$ERROR_MESSAGE" |
| 37 | + echo "ERROR_MESSAGE=$ERROR_MESSAGE" >> $GITHUB_ENV |
| 38 | + exit 1 |
| 39 | + fi |
| 40 | + else |
| 41 | + echo "Info: Not a rel/* branch or tag push. Exiting successfully." |
| 42 | + exit 0 |
| 43 | + fi |
| 44 | +
|
| 45 | + # Extract version from Version.swift |
| 46 | + SWIFT_VERSION=$(grep -o '__klaviyoSwiftVersion = "[^"]*"' Sources/KlaviyoCore/Utils/Version.swift | sed 's/.*"\([^"]*\)".*/\1/') |
| 47 | + echo "Version.swift version: $SWIFT_VERSION" |
| 48 | +
|
| 49 | + # Extract versions from all podspec files |
| 50 | + PODSPEC_VERSIONS="" |
| 51 | + PODSPEC_ERRORS="" |
| 52 | + for podspec in *.podspec; do |
| 53 | + if [ -f "$podspec" ]; then |
| 54 | + PODSPEC_VERSION=$(grep -o 's\.version.*=.*"[^"]*"' "$podspec" | sed 's/.*"\([^"]*\)".*/\1/') |
| 55 | + echo "Podspec $podspec version: $PODSPEC_VERSION" |
| 56 | + if [ "$VERSION_NAME" != "$PODSPEC_VERSION" ]; then |
| 57 | + PODSPEC_ERRORS="$PODSPEC_ERRORS\n❌ $podspec version mismatch: expected $VERSION_NAME, found $PODSPEC_VERSION" |
| 58 | + else |
| 59 | + echo "✅ $podspec version matches: $PODSPEC_VERSION" |
| 60 | + fi |
| 61 | + PODSPEC_VERSIONS="$PODSPEC_VERSIONS $podspec:$PODSPEC_VERSION" |
| 62 | + fi |
| 63 | + done |
| 64 | +
|
| 65 | + # Compare versions |
| 66 | + if [ "$VERSION_NAME" = "$SWIFT_VERSION" ] && [ -z "$PODSPEC_ERRORS" ]; then |
| 67 | + echo "✅ All version matches confirmed: $VERSION_NAME" |
| 68 | + else |
| 69 | + ERROR_MESSAGE="❌ Version mismatch detected!" |
| 70 | + if [ "$VERSION_NAME" != "$SWIFT_VERSION" ]; then |
| 71 | + ERROR_MESSAGE="$ERROR_MESSAGE\n❌ Version.swift mismatch: expected $VERSION_NAME, found $SWIFT_VERSION" |
| 72 | + fi |
| 73 | + if [ -n "$PODSPEC_ERRORS" ]; then |
| 74 | + ERROR_MESSAGE="$ERROR_MESSAGE$PODSPEC_ERRORS" |
| 75 | + fi |
| 76 | + ERROR_MESSAGE="$ERROR_MESSAGE\n\nPlease update version numbers in Sources/KlaviyoCore/Utils/Version.swift and all *.podspec files (or correct the branch/tag name)." |
| 77 | + echo -e "$ERROR_MESSAGE" |
| 78 | + echo "VERSION_NAME=$VERSION_NAME" >> $GITHUB_ENV |
| 79 | + echo "SWIFT_VERSION=$SWIFT_VERSION" >> $GITHUB_ENV |
| 80 | + echo "PODSPEC_VERSIONS=$PODSPEC_VERSIONS" >> $GITHUB_ENV |
| 81 | + echo "ERROR_MESSAGE=$ERROR_MESSAGE" >> $GITHUB_ENV |
| 82 | + exit 1 |
| 83 | + fi |
| 84 | +
|
| 85 | + # Send Slack notification on failure |
| 86 | + - name: Send Slack notification on failure |
| 87 | + if: failure() |
| 88 | + |
| 89 | + with: |
| 90 | + webhook: ${{ secrets.SLACK_WEBHOOK_URL }} |
| 91 | + webhook-type: incoming-webhook |
| 92 | + payload: | |
| 93 | + text: "🚨 Release Version Mismatch Detected" |
| 94 | + blocks: |
| 95 | + - type: "section" |
| 96 | + text: |
| 97 | + type: "mrkdwn" |
| 98 | + text: "🚨 Release Version Mismatch Detected\n" |
| 99 | + - type: "section" |
| 100 | + text: |
| 101 | + type: "mrkdwn" |
| 102 | + text: "*Repository:* ${{ github.repository }}\n*Ref:* `${{ github.ref_name }}`\n*Expected Version:* `${{ env.VERSION_NAME }}`\n*Version.swift Version:* `${{ env.SWIFT_VERSION }}`\n*Podspec Versions:* `${{ env.PODSPEC_VERSIONS }}`\n*Error:* `${{ env.ERROR_MESSAGE }}`\n*Action:* Please update version numbers in `Sources/KlaviyoCore/Utils/Version.swift` and all `*.podspec` files (or correct the branch/tag name)." |
| 103 | + - type: "section" |
| 104 | + text: |
| 105 | + type: "mrkdwn" |
| 106 | + text: "*Workflow Run:* <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View Details>" |
0 commit comments