[release] improve release steps naming (#260)

Author: SylvainJuge

.github/workflows/README.md

@@ -0,0 +1,17 @@
+### Release process
+
+To release a new version of ecs-logging-java, you must use the two GitHub Workflows.
+
+- Trigger the `release-step-1` GH workflow
+  - parameters: version to release
+  - will open `release-step-2` PR
+- Review and merge the `release-step-2` PR to `main` (version bump to release)
+- Trigger the `release-step-3` GH workflow
+  - parameters: version to release and the `main` branch (or merge commit/ref of `release-step-2` PR merge).
+  - will generate and publish release artifact through buildkite.
+  - will open `release-step-4` PR
+- Review and merge the `release-step-4` PR to `main` (version bump from release to next snapshot version)
+
+The tag release follows the naming convention: `v.<major>.<minor>.<patch>`, where `<major>`, `<minor>` and `<patch>`.
+
+

.github/workflows/pre-post-release.yml

@@ -17,6 +17,14 @@ on:
         description: 'Pre or post release phase'
         type: string # valid values are 'pre' or 'post'
         required: true
+      pr_title:
+        description: 'pull-request title'
+        type: string
+        required: true
+      pr_body:
+        description: : 'pull-request body'
+        type: string
+        required: true
 
 env:
   RELEASE_VERSION: ${{ inputs.version }}
@@ -91,4 +99,4 @@ jobs:
           git push origin ${{ env.BRANCH_NAME }}
 
       - name: Create the ${{ inputs.phase }} release PR
-        run: gh pr create --title="${{ inputs.phase }} release v${{ env.RELEASE_VERSION }}" --base main --head ${{ env.BRANCH_NAME }} -b "${{ inputs.phase }} release v${{ env.RELEASE_VERSION }}"
+        run: gh pr create --title="${{ inputs.pr_title }}" --base main --head ${{ env.BRANCH_NAME }} -b "${{ inputs.pr_body }}"

.github/workflows/pre-release.yml renamed to .github/workflows/release-step-1.yml

@@ -1,5 +1,5 @@
 ---
-name: Pre release
+name: release-step-1
 
 on:
   workflow_dispatch:
@@ -28,4 +28,8 @@ jobs:
       ref: ${{ inputs.ref }}
       version: ${{ inputs.version }}
       phase: 'pre'
+      pr_title: "[release] release-step-2 ${{ inputs.version }}"
+      pr_body: "Step 2 of the release process for version ${{ inputs.version }}: review & merge, then execute 'release-step-3' GH workflow"
     secrets: inherit
+
+# TODO: rename PR "release step 2"

.github/workflows/release.yml renamed to .github/workflows/release-step-3.yml

@@ -1,5 +1,5 @@
 ---
-name: Release
+name: release-step-3
 
 on:
   workflow_dispatch:
@@ -164,4 +164,6 @@ jobs:
       ref: ${{ inputs.ref }}
       version: ${{ inputs.version }}
       phase: 'post'
+      pr_title: "[release] release-step-4 ${{ inputs.version }}"
+      pr_body: "Step 4 of the release process for version ${{ inputs.version }}: review & merge"
     secrets: inherit