[DRAFT/ILLUSTRATION] Release workflows for polaris-tools

.github/workflows/apprunner-ci.yml

@@ -28,11 +28,12 @@ name: Apprunner CI
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "release/*" ]
     paths:
       - 'apprunner/**'
       - '.github/**'
   pull_request:
+    branches: [ "main", "release/*" ]
     paths:
       - 'apprunner/**'
       - '.github/**'

.github/workflows/release-1-create-release-branch.yml

@@ -0,0 +1,131 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+name: Release - 1 - Create Release Branch
+
+on:
+  workflow_dispatch:
+    inputs:
+      tool:
+        description: 'The tool directory to release (e.g., apprunner or iceberg-catalog-migrator)'
+        required: true
+        type: string
+      version:
+        description: 'Release version without RC number (e.g., 1.0.0-incubating)'
+        required: true
+        type: string
+      dry_run:
+        description: 'Dry run mode (check to enable, uncheck to perform actual operations)'
+        required: false
+        type: boolean
+        default: true
+
+jobs:
+  create-release-branch:
+    name: Release - 1 - Create Release Branch
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+        with:
+          # Fetch full history for proper branch operations
+          fetch-depth: 0
+          # Use a token with write permissions
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up environment variables
+        run: |
+          echo "RELEASEY_DIR=$(pwd)/releasey" >> $GITHUB_ENV
+          echo "LIBS_DIR=$(pwd)/releasey/libs" >> $GITHUB_ENV
+
+          echo "## Mode" >> $GITHUB_STEP_SUMMARY
+          if [[ "${{ github.event.inputs.dry_run }}" == "true" ]]; then
+            echo "DRY_RUN=1" >> $GITHUB_ENV
+            echo "‼️ DRY_RUN mode enabled - No actual changes will be made" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "DRY_RUN=0" >> $GITHUB_ENV
+            echo "DRY_RUN mode disabled - Performing actual operations" >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Validate release parameters
+        run: |
+          source "${LIBS_DIR}/_version.sh"
+
+          # Extract release parameters from workflow inputs
+          tool="${{ github.event.inputs.tool }}"
+          version="${{ github.event.inputs.version }}"
+
+          echo "## Parameters" >> $GITHUB_STEP_SUMMARY
+
+          if [[ ! -d "${tool}/releasey" ]]; then
+            echo "❌ The directory ${tool}/releasey does not exist." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          # Validate version format and extract components
+          if ! validate_and_extract_polaris_version "${version}"; then
+            echo "❌ Invalid version format. Expected: major.minor.patch-incubating, got: ${version}" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          echo "Tool: \`${tool}\`" >> $GITHUB_STEP_SUMMARY
+          echo "Version: \`${version}\`" >> $GITHUB_STEP_SUMMARY
+
+          # Create branch name in major.minor.x format
+          branch_name="${tool}/${major}.${minor}.x"
+
+          # Export parameters for next step
+          echo "tool=${tool}" >> $GITHUB_ENV
+          echo "version=${version}" >> $GITHUB_ENV
+          echo "branch_name=${branch_name}" >> $GITHUB_ENV
+
+      - name: Create release branch
+        run: |
+          source "${LIBS_DIR}/_exec.sh"
+
+          release_branch="release/${branch_name}"
+
+          echo "## Summary" >> $GITHUB_STEP_SUMMARY
+
+          # Check if release branch already exists
+          if git show-ref --verify --quiet "refs/remotes/origin/${release_branch}"; then
+            echo "❌ Release branch ${release_branch} already exists. Delete the existing branch manually if you want to recreate it." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          exec_process git branch "${release_branch}"
+          exec_process git push origin "${release_branch}" --set-upstream
+
+          cat <<EOT >> $GITHUB_STEP_SUMMARY
+          🎉 Release branch created successfully:
+
+          | Name | Value |
+          | --- | --- |
+          | Release branch name | \`${release_branch}\` |
+          | Ref | \`$(git rev-parse HEAD)\` |
+          | Version | \`${version}\` |
+          EOT

.github/workflows/release-2-update-release-candidate.yml

@@ -0,0 +1,211 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+name: Release - 2 - Update version and Changelog for Release Candidate
+
+on:
+  workflow_dispatch:
+    inputs:
+      dry_run:
+        description: 'Dry run mode (check to enable, uncheck to perform actual operations)'
+        required: false
+        type: boolean
+        default: true
+
+jobs:
+  update-release-candidate:
+    name: Release - 2 - Update version and Changelog for Release Candidate
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+        with:
+          # Fetch full history. Branch operations require this.
+          fetch-depth: 0
+          # Use a token with write permissions
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Set up environment variables
+        run: |
+          echo "RELEASEY_DIR=$(pwd)/releasey" >> $GITHUB_ENV
+          echo "LIBS_DIR=$(pwd)/releasey/libs" >> $GITHUB_ENV
+
+          echo "## Mode" >> $GITHUB_STEP_SUMMARY
+          if [[ "${{ github.event.inputs.dry_run }}" == "true" ]]; then
+            echo "DRY_RUN=1" >> $GITHUB_ENV
+            echo "‼️ DRY_RUN mode enabled - No actual changes will be made" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "DRY_RUN=0" >> $GITHUB_ENV
+            echo "DRY_RUN mode disabled - Performing actual operations" >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Auto-determine release branch and next RC number
+        run: |
+          source "${LIBS_DIR}/_version.sh"
+
+          # Get the current branch name
+          current_branch=$(git branch --show-current)
+
+          echo "## Parameters" >> $GITHUB_STEP_SUMMARY
+
+          # Validate that we're on a release branch
+          if [[ ! "${current_branch}" =~ ^release/([a-z-]+)-(.+)$ ]]; then
+            echo "❌ Invalid branch: \`${current_branch}\`. This workflow must be run from a release branch (release/major.minor.x)" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          # Extract tool name and version from release branch name
+          tool="${BASH_REMATCH[1]}"
+          branch_version="${BASH_REMATCH[2]}"
+
+          if [[ ! -d "${tool}/releasey" ]]; then
+            echo "❌ The directory ${tool}/releasey does not exist." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          # Validate branch version format and extract components
+          if ! validate_and_extract_branch_version "${branch_version}"; then
+            echo "❌ Invalid release branch version format: \`${branch_version}\`, expected: major.minor.x" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          # Find the next available patch number for this major.minor version
+          find_next_patch_number "${major}" "${minor}"
+
+          # Build the target version using branch major.minor and determined patch
+          version_without_rc="${major}.${minor}.${patch}-incubating"
+
+          # Find the next available RC number by checking existing tags
+          find_next_rc_number "${version_without_rc}"
+
+          # Build the new release tag
+          release_tag="apache-polaris-${tool}-${version_without_rc}-rc${rc_number}"
+
+          # Export all variables for next steps
+          echo "release_tag=${release_tag}" >> $GITHUB_ENV
+          echo "tool=${tool}" >> $GITHUB_ENV
+          echo "major=${major}" >> $GITHUB_ENV
+          echo "minor=${minor}" >> $GITHUB_ENV
+          echo "patch=${patch}" >> $GITHUB_ENV
+          echo "rc_number=${rc_number}" >> $GITHUB_ENV
+          echo "version_without_rc=${version_without_rc}" >> $GITHUB_ENV
+          echo "release_branch=${current_branch}" >> $GITHUB_ENV
+
+          cat <<EOT >> $GITHUB_STEP_SUMMARY
+          | Parameter | Value |
+          | --- | --- |
+          | Tool | \`${tool}\` |
+          | Release branch | \`${current_branch}\` |
+          | Version without RC | \`${version_without_rc}\` |
+          | RC number | \`${rc_number}\` |
+          | Release tag | \`${release_tag}\` |
+          EOT
+
+      - name: Verify GitHub checks are passing
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          source "${LIBS_DIR}/_github.sh"
+
+          # Get the current HEAD commit SHA
+          current_commit=$(git rev-parse HEAD)
+
+          echo "## Validation" >> $GITHUB_STEP_SUMMARY
+
+          # Verify all GitHub checks are passing
+          if ! check_github_checks_passed "${current_commit}"; then
+            echo "❌ GitHub checks are not all passing for commit \`${current_commit}\`. Please ensure all checks pass before updating the release candidate." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+          echo "All GitHub checks are passing for commit \`${current_commit}\`" >> $GITHUB_STEP_SUMMARY
+
+      - name: Set up Java
+        uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Update project versions
+        if: env.rc_number == '0'
+        run: |
+          source "${LIBS_DIR}/_version.sh"
+
+          # Call tool-specific version update script
+          (cd ${tool} ; ./releasey/update_version.sh)
+
+          cat <<EOT >> $GITHUB_STEP_SUMMARY
+          ## Version update
+          All version files updated to \`${version_without_rc}\`
+          EOT
+
+      - name: Update changelog
+        if: env.rc_number == '0'
+        run: |
+          # Call tool-specific update changelog script
+          (cd ${tool} ; ./releasey/update_changelog.sh)
+
+          cat <<EOT >> $GITHUB_STEP_SUMMARY
+          ## Changelog
+          Changelog patched successfully
+          EOT
+
+      - name: Commit and push changes
+        if: env.rc_number == '0'
+        run: |
+          source "${LIBS_DIR}/_constants.sh"
+          source "${LIBS_DIR}/_exec.sh"
+
+          # Commit version files and changelog
+          exec_process git commit -m "[chore] Bump version to ${version_without_rc}"
+
+          # Push the changes
+          exec_process git push origin "${release_branch}"
+
+      - name: Create RC tag at new commit
+        run: |
+          source "${LIBS_DIR}/_exec.sh"
+
+          # Get the new commit SHA after our changes
+          new_tag_ref=$(git rev-parse HEAD)
+          echo "new_tag_ref=${new_tag_ref}" >> $GITHUB_ENV
+
+          # Create the tag at the new commit
+          exec_process git tag "${release_tag}" "${new_tag_ref}"
+          exec_process git push origin "${release_tag}"
+
+          echo "## Summary" >> $GITHUB_STEP_SUMMARY
+          cat <<EOT >> $GITHUB_STEP_SUMMARY
+          🎉 Release candidate tag created successfully:
+
+          | Name | Value |
+          | --- | --- |
+          | Release candidate tag | \`${release_tag}\` |
+          | Commit | \`${new_tag_ref}\` |
+          | Version | \`${version_without_rc}\` |
+          | RC number | \`${rc_number}\` |
+          EOT