PI-2374: Add deployment stage to publishing workflow

Author: mxco86

.github/workflows/publish-docs.yml

@@ -34,8 +34,31 @@ jobs:
         working-directory: tech-docs
       - name: Bundle OpenAPI specs
         run: |
-          curl -sf localhost:8080/v3/api-docs -o api-docs.json
+          mkdir openapi
+          curl -sf localhost:8080/v3/api-docs -o openapi/api-docs.json
         working-directory: tech-docs/build
       - uses: actions/upload-artifact@v4
         with:
-          path: tech-docs/build
+          name: documentation
+          path: tech-docs/build/
+
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.ref_name == 'main' || (github.event_name == 'workflow_dispatch')
+    needs:
+      - build
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: documentation
+          path: tech-docs-build
+      - name: debug
+        run: |
+          ls -la
+          ls -laR tech-docs-build
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@920cbb300dcd3f0568dbc42700c61e2fd9e6139c # v4.6.4
+        with:
+          folder: tech-docs-build

tech-docs/config/tech-docs.yml

@@ -37,4 +37,4 @@ show_contribution_banner: true
 github_repo: ministryofjustice/hmpps-integration-api-docs
 github_branch: main
 
-api_path: https://ministryofjustice.github.io/hmpps-integration-api/openapi/api-docs.json
+# api_path: https://ministryofjustice.github.io/hmpps-integration-api/openapi/api-docs.json

tech-docs/source/documentation/api/index.html.md.erb

@@ -6,7 +6,7 @@ last_reviewed_on: 2024-09-03
 review_in: 3 months
 ---
 
-api>
+# API Docs
 
 ## OpenAPI Specification