Gh-3259: Improve release process (#3260)

cn337131 · web-flow · commit dc892f1d9afa · 2024-08-05T09:06:00.000Z
* update release pipelines

* simplify

* release notes fix

* remove comment

* address comments
diff --git a/.github/release-notes.yml b/.github/release-notes.yml
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,23 @@
+changelog:
+  categories:
+    - title: Headliners
+      labels:
+        - headliner
+    - title: New Features
+      labels:
+        - feature
+    - title: Enhancements
+      labels:
+        - enhancement
+    - title: Bugs Fixed
+      labels:
+        - bug
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Automation
+      labels:
+        - automation
+    - title: Other changes
+      labels:
+        - "*"
diff --git a/.github/workflows/create-release-branch.yaml b/.github/workflows/create-release-branch.yaml
@@ -1,11 +1,9 @@
 name: Create Release Branch
 
 on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Release Branch Version'
-        required: false
+  milestone:
+    types:
+    - closed
 
 env:
   artifactId: gaffer2
@@ -23,28 +21,11 @@ jobs:
         token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
         fetch-depth: 0
 
-    - name: Set version from input
-      if: ${{ github.event.inputs.version }}
-      run: echo "RELEASE_VERSION=$(echo ${{ github.event.inputs.version }} | sed 's/^v//')" >> $GITHUB_ENV
-
-    - name: Get latest tag
-      if: ${{ !github.event.inputs.version }}
-      uses: actions-ecosystem/action-get-latest-tag@v1
-      id: get-latest-tag
-
-    - name: Format latest tag
-      if: ${{ !github.event.inputs.version }}
-      run: echo "CURRENT_VERSION=$(echo ${{ steps.get-latest-tag.outputs.tag }} | sed 's/^gaffer2-//')" >> $GITHUB_ENV
-
-    - name: Bump latest tag variable version
-      if: ${{ !github.event.inputs.version }}
-      run: echo "RELEASE_VERSION=$(echo ${{ env.CURRENT_VERSION }} | sed -r 's/([0-9]+)\.([0-9]+)\.([0-9]+)/echo \1.$((\2+1)).0/' | sh)" >> $GITHUB_ENV
-
-    - name: Verify version regex
-      run: echo ${{ env.RELEASE_VERSION }} | grep -E '^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$'
+    - name: Set version from milestone
+      run: echo "RELEASE_VERSION=$(echo ${{ github.event.milestone.title }})" >> $GITHUB_ENV
 
     - name: Set release branch
-      run: echo "BRANCH_NAME=$(echo release/${{ env.RELEASE_VERSION }} )" >> $GITHUB_ENV
+      run: echo "BRANCH_NAME=$(echo release/"${{ env.RELEASE_VERSION }}" )" >> $GITHUB_ENV
 
     - name: Set up Github credentials
       run: |
@@ -54,10 +35,20 @@ jobs:
     - name: Update versions
       run: |
         mvn versions:set-property -Dproperty=revision -DnewVersion=${RELEASE_VERSION} -DgenerateBackupPoms=false
-        sed -i'' -e "s/^gaffer.version=.*/gaffer.version=$RELEASE_VERSION/" rest-api/common-rest/src/main/resources/version.properties
 
     - name: Push to release branch
       run: |
         git checkout -b $BRANCH_NAME
         git commit -a -m "prepare release $artifactId-$RELEASE_VERSION"
         git push --set-upstream origin $BRANCH_NAME
+
+    - name: Tag release branch
+      run: |
+        git tag gaffer2-$RELEASE_VERSION
+        git push origin --tags
+
+    - name: Create PR to master
+      run: |
+        gh pr create -B master -H $BRANCH_NAME --title 'Merge release into master branch' --body 'Created by GH Action'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -1,21 +1,22 @@
 name: Full Release
 
 on:
-  milestone:
-    types:
-    - closed
+  pull_request:
+    branches:
+        - master
+    types: [closed]
 
 env:
   artifactId: gaffer2
   MAVEN_OPTS: -Dmaven.wagon.http.retryHandler.count=3 -Dmaven.wagon.httpconnectionManager.ttlSeconds=25
 
-
 jobs:
-  create-release-tag:
+  deploy-release:
+    if: ${{ github.event.pull_request.merged }}
     runs-on: ubuntu-latest
 
     outputs:
-      branch_name: ${{ steps.branch.outputs.branch_name }}
+      release_version: ${{ steps.release-version.outputs.release_version }}
 
     steps:
     - name: Setup JDK
@@ -36,106 +37,15 @@ jobs:
         git config user.name github-actions[bot]
         git config user.email 41898282+github-actions[bot]@users.noreply.github.com
 
-    - name: Set release version
-      run: echo "RELEASE_VERSION=$(echo ${{ github.event.milestone.title }} | cut -c 2-)" >> $GITHUB_ENV
-
-    - name: Set branch name
-      run: echo "BRANCH_NAME=$(git branch -a | grep $RELEASE_VERSION | tail -n 1 | cut -c 18-)" >> $GITHUB_ENV
-
-    - name: Output branch name
-      id: branch
-      run: echo "branch_name=$BRANCH_NAME" >> $GITHUB_OUTPUT
-
-    - name: Fail if branch output missing (no branch found)
-      if: ${{ !steps.branch.outputs.branch_name }}
-      run: exit 1
-
-    - name: Merge release into master
-      run: |
-        git checkout ${{ env.BRANCH_NAME }}
-        git checkout master
-        git merge ${{ env.BRANCH_NAME }}
-
-    - name: Push changes
-      run: |
-        git tag $artifactId-$RELEASE_VERSION
-        git push origin $artifactId-$RELEASE_VERSION
-        git push
-
-  update-develop:
-    runs-on: ubuntu-latest
-    needs:
-    - create-release-tag
-
-    steps:
-    - name: Checkout develop
-      uses: actions/checkout@v4
-      with:
-        ref: develop
-        token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
-        fetch-depth: 0
-
-    - name: Set up Github credentials
-      run: |
-        git config user.name github-actions[bot]
-        git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-
-    - name: Setup JDK
-      uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: '8'
-
-    - name: Merge release into develop
-      run: |
-        git checkout ${{ needs.create-release-tag.outputs.branch_name }}
-        git checkout develop
-        git merge ${{ needs.create-release-tag.outputs.branch_name }} --strategy-option theirs
-
-    - name: Update develop branch
+    - name: Output release version
+      id: release-version
       run: |
-        git checkout develop
-        mvn versions:set-property -Dproperty=revision -DnewVersion=$(echo ${{ github.event.milestone.title }} | cut -c 2-)-SNAPSHOT
-        mvn build-helper:parse-version versions:set-property \
-            -Dproperty=revision \
-            -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion}-SNAPSHOT
-        NEW_GAFFER_VERSION=$(mvn -q help:evaluate -DforceStdout -Dexpression=pom.version)
-        sed -i'' -e "s/^gaffer.version=.*/gaffer.version=$NEW_GAFFER_VERSION/" rest-api/common-rest/src/main/resources/version.properties
-        git commit -a -m "prepare for next development iteration"
-        git push
-
-  update-github-releases:
-    runs-on: ubuntu-latest
-    needs:
-    - create-release-tag
-
-    steps:
-    - name: Checkout Master
-      uses: actions/checkout@v4
-      with:
-        ref: master
-
-    - name: Create Release Notes
-      uses: docker://decathlon/release-notes-generator-action:3.1.5
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Set version
-      run: echo "RELEASE_VERSION=$(echo ${{ github.event.milestone.title }} | cut -c 2-)" >> $GITHUB_ENV
-
-    - name: Upload notes
-      uses: softprops/action-gh-release@v2
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        tag_name: ${{ env.artifactId }}-${{ env.RELEASE_VERSION }}
-        name: Gaffer ${{ env.RELEASE_VERSION }}
-        body_path: release_file.md
+        echo "release_version=$(mvn -q help:evaluate -DforceStdout -Dexpression=pom.version)" >> $GITHUB_OUTPUT
 
   generate-javadoc:
     runs-on: ubuntu-latest
     needs:
-    - create-release-tag
+    - deploy-release
 
     steps:
     - name: Checkout Master
@@ -156,7 +66,7 @@ jobs:
         java-version: '11'
 
     - name: Set version
-      run: echo "RELEASE_VERSION=$(echo ${{ github.event.milestone.title }} | cut -c 2-)" >> $GITHUB_ENV
+      run: echo "RELEASE_VERSION=$(echo ${{ needs.deploy-release.outputs.release_version }})" >> $GITHUB_ENV
 
     - name: Upload Javadoc
       run: |
@@ -176,7 +86,7 @@ jobs:
   release-to-nexus:
     runs-on: ubuntu-latest
     needs:
-    - create-release-tag
+    - deploy-release
 
     steps:
     - name: Setup JDK
@@ -188,7 +98,7 @@ jobs:
     - name: Checkout release
       uses: actions/checkout@v4
       with:
-        ref: ${{ needs.create-release-tag.outputs.branch_name }}
+        ref: master
 
     - name: Decode CodeSigning key
       env:
@@ -205,4 +115,65 @@ jobs:
         GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
         OSS_NEXUS_USERNAME: ${{ secrets.OSS_NEXUS_USERNAME }}
         OSS_NEXUS_PASSWORD: ${{ secrets.OSS_NEXUS_PASSWORD }}
-      run: mvn deploy -P quick,ossrh-release --settings cd/mvnsettings.xml -B
+      run:
+        mvn deploy -P quick,ossrh-release --settings cd/mvnsettings.xml -B
+
+  update-github-releases:
+    runs-on: ubuntu-latest
+    needs:
+    - deploy-release
+
+    steps:
+    - name: Checkout Master
+      uses: actions/checkout@v4
+      with:
+        ref: master
+
+    - name: Set version
+      run: echo "RELEASE_VERSION=$(echo ${{ needs.deploy-release.outputs.release_version }})" >> $GITHUB_ENV
+
+    - name: Create github release
+      uses: softprops/action-gh-release@v2
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ env.artifactId }}-${{ env.RELEASE_VERSION }}
+        name: Gaffer ${{ env.RELEASE_VERSION }}
+
+  update-develop:
+    runs-on: ubuntu-latest
+    needs:
+    - deploy-release
+
+    steps:
+    - name: Checkout develop
+      uses: actions/checkout@v4
+      with:
+        ref: develop
+        token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+        fetch-depth: 0
+
+    - name: Set up Github credentials
+      run: |
+        git config user.name github-actions[bot]
+        git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+    - name: Setup JDK
+      uses: actions/setup-java@v4
+      with:
+        distribution: 'zulu'
+        java-version: '8'
+
+    - name: Merge master into develop
+      run: |
+        git merge origin/master
+
+    - name: Update develop branch
+      run: |
+        git checkout develop
+        mvn versions:set-property -Dproperty=revision -DnewVersion=$(echo ${{ needs.deploy-release.outputs.release_version }})-SNAPSHOT
+        mvn build-helper:parse-version versions:set-property \
+            -Dproperty=revision \
+            -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion}-SNAPSHOT
+        git commit -a -m "prepare for next development iteration"
+        git push
