ci(release): further finetuning and documentation

Author: Aaron-Ritter

.github/workflows/release.yaml

@@ -11,7 +11,7 @@ permissions:
   pull-requests: write
   repository-projects: read
   # only required for workflows in private repositories
-  actions: read
+  actions: write
   security-events: write
   # required to fetch internal or private CodeQL packs
   packages: read
@@ -20,7 +20,8 @@ concurrency:
   group: release
 
 jobs:
-  # This job creates the necessary labels for the release-please PRs
+  # This job creates the necessary labels for the release-please PRs:
+  # https://github.com/googleapis/release-please-action/issues/1074
   label-check:
     name: Create release-please PR labels
     runs-on: ubuntu-latest
@@ -62,7 +63,8 @@ jobs:
     name: Run Prerelease CodeQL Samples Quickstart Scan
     uses: ./.github/workflows/codeql-samples-quickstart.yml
 
-  # This job creates or finalizes a prerelease pull request and provides the necessary outputs for the subsequent jobs
+  # This job creates or finalizes a prerelease pull request or finalizes a release pull request
+  # and provides the necessary outputs for the subsequent jobs
   prerelease-prep:
     name: Create Prerelease Pull Request
     runs-on: ubuntu-latest
@@ -78,18 +80,29 @@ jobs:
           config-file: ".github/prerelease-config.json"
           manifest-file: ".github/prerelease-manifest.json"
 
-  # This job runs the E2E tests with FusionAuth Matrix as a prerequisite for the prerelease job
+  # This job runs tests before the creation of the prerelease
+  prerelease-test:
+    name: Run Prerelease Tests
+    runs-on: ubuntu-latest
+    if: ${{ needs.prerelease-prep.outputs.releases_created == 'false' }}
+    needs: [ prerelease-prep ]
+    steps:
+      - name: End To End Test
+        run: |
+          echo "Running end to end tests for prerelease!"
+
+  # This job runs the E2E tests with FusionAuth Matrix as a prerequisite for creating the prerelease
   prerelease-e2e-test-fusionauth-matrix:
     name: Run Prerelease E2E Tests with FusionAuth Matrix
-    if: ${{ needs.prerelease-prep.outputs.releases_created == 'true' && contains(needs.prerelease-prep.outputs.tag_name, 'rc') }}
-    needs: prerelease-prep
+    if: ${{ needs.prerelease-prep.outputs.releases_created == 'false' }}
+    needs: [ prerelease-prep ]
     uses: ./.github/workflows/e2e-test-fusionauth-matrix-ios-latest.yml
 
-  # This job runs the E2E tests with iOS Matrix as a prerequisite for the prerelease job
+  # This job runs the E2E tests with iOS Matrix as a prerequisite for creating the prerelease
   prerelease-e2e-test-ios-matrix:
     name: Run Prerelease E2E Tests with iOS Matrix
-    if: ${{ needs.prerelease-prep.outputs.releases_created == 'true' && contains(needs.prerelease-prep.outputs.tag_name, 'rc') }}
-    needs: prerelease-prep
+    if: ${{ needs.prerelease-prep.outputs.releases_created == 'false' }}
+    needs: [ prerelease-prep ]
     uses: ./.github/workflows/e2e-test-fusionauth-latest-ios-matrix.yml
 
   # This job runs creates the Prerelease and creates a subsequent Release Pull Request
@@ -109,12 +122,23 @@ jobs:
           config-file: ".github/release-config.json"
           manifest-file: ".github/release-manifest.json"
 
+  # This job runs post-prerelease steps
+  post-prerelease:
+    name: Post Prerelease Steps
+    runs-on: ubuntu-latest
+    needs: [ prerelease ]
+    if: ${{ needs.prerelease-prep.outputs.releases_created == 'true' && contains(needs.prerelease-prep.outputs.tag_name, 'rc') }}
+    steps:
+      - name: Post Prerelease Step
+        run: |
+          echo "Running post-prerelease steps!"
+
   # This job creates the final release and Syncs the prerelease manifest
   release:
     name: Create Release
     runs-on: ubuntu-latest
     if: ${{ needs.prerelease-prep.outputs.releases_created == 'true' && !contains(needs.prerelease-prep.outputs.tag_name, 'rc') }}
-    needs: prerelease-prep
+    needs: [ prerelease-prep ]
     steps:
       - name: Release Step
         run: |
@@ -143,7 +167,7 @@ jobs:
   post-release:
     name: Post Release Steps
     runs-on: ubuntu-latest
-    needs: release
+    needs: [ release ]
     steps:
       - name: Post Release Step
         run: |