Restructure Release Drafter Flow

DefectDojo · Jan 16, 2024 · ceb9cf0 · ceb9cf0
1 parent edf870f
commit ceb9cf0
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 14 deletions.
diff --git a/.github/workflows/fetch-oas.yml b/.github/workflows/fetch-oas.yml
@@ -2,6 +2,13 @@ name: Fetch OpenAPI Specifications
 
 on:
   workflow_call:
+    inputs:
+      version:
+        type: string
+        description: |
+          The version to be associated with the GitHub release that's created or updated.
+          This will override any version calculated by the release-drafter.
+        required: false
 
 jobs:
   oas_fetch:

diff --git a/.github/workflows/release-2-tag-docker-push.yml b/.github/workflows/release-2-tag-docker-push.yml
@@ -46,3 +46,10 @@ jobs:
     with:
       release_number: ${{ github.event.inputs.release_number }}
     secrets: inherit
+
+  release-drafter:
+    needs: release-docker-containers
+    uses: ./.github/workflows/release-drafter.yml
+    with:
+      version: ${{ github.event.inputs.release_number }}
+    secrets: inherit
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -1,38 +1,42 @@
 name: Release Drafter
 
 on:
-  workflow_dispatch:
+  workflow_call:
     inputs:
       version:
+        type: string
         description: |
           The version to be associated with the GitHub release that's created or updated.
           This will override any version calculated by the release-drafter.
         required: false
 
-  push:
-    # branches to consider in the event; optional, defaults to all
-    branches:
-      - master
-
 jobs:
-  oas-fetch:
-    uses: ./.github/workflows/fetch-oas.yml
-    secrets: inherit
-
+  # Update the notes in the release drafter first
+  # If the following jobs fail, then we will at least have some release notes present
   update_release_draft:
-    needs: oas-fetch
     runs-on: ubuntu-latest
     steps:
-      - name: Load OAS files from artifacts
-        uses: actions/download-artifact@v3
-
       - name: Create Release
         id: create_release
         uses: release-drafter/[email protected]
         with:
           version: ${{github.event.inputs.version}}  
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  # Generate the OAS schemas in another workflow
+  oas-fetch:
+    needs: update_release_draft
+    uses: ./.github/workflows/fetch-oas.yml
+    with:
+      version: ${{github.event.inputs.version}} 
+    secrets: inherit
+  # Upload the OAS schemas to the release object
+  add-oas-to-release:
+    needs: oas-fetch
+    runs-on: ubuntu-latest
+    steps:
+      - name: Load OAS files from artifacts
+        uses: actions/download-artifact@v3
 
       - name: Upload Release Asset - OpenAPI Specification - YAML
         id: upload-release-asset-yaml
@@ -55,3 +59,5 @@ jobs:
           asset_path: ./oas-json/oas.json
           asset_name: oas.json
           asset_content_type: application/json
+
+