🚀 Add code validation workflow

.github/workflows/backend-integration-azure-bicep-validate.yml → .github/workflows/backend-integration-azure_bicep_validate.yml

@@ -16,7 +16,7 @@ concurrency:
 
 jobs:
   backend-integration-validation: 
-    uses: ./.github/workflows/lib-azure-bicep-validation.yml
+    uses: ./.github/workflows/lib-azure_bicep_validation.yml
     with:
       work-dir: backend-integration
     secrets:

.github/workflows/backend-integration-azure-deploy.yml → .github/workflows/backend-integration-azure_deploy.yml

@@ -18,7 +18,7 @@ concurrency:
 
 jobs:
   backend-integration-dev: 
-    uses: ./.github/workflows/lib-azure-deploy.yml
+    uses: ./.github/workflows/lib-azure_deploy.yml
     with:
       work-dir: backend-integration
       environment: ${{ vars.BACKEND_INTEGRATION_ENV_NAME }}

.github/workflows/backend-integration-code_validation_and_docs.yml

@@ -0,0 +1,23 @@
+name: Backend Integration - Checks & documentation
+
+on:
+  pull_request:
+    paths:
+        - 'backend-integration/**'
+        - '.github/workflows/backend-integration-dev-code_validation_and_docs.yml'
+
+# Use concurrency to ensure that only a single job or workflow using the same concurrency group will run at a time
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true  # Cancel previously queued jobs and run the latest
+
+jobs:
+  backend-integration:
+    uses: ./.github/workflows/lib-backend_code_validation_and_docs.yml
+    with:
+        app-name: backend-integration
+        environment: dev
+        work-dir: backend-integration
+        repo-name: azure-function-app-boilerplate
+    secrets:
+        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/lib-backend_code_validation_and_docs.yml

@@ -0,0 +1,109 @@
+name: Checks & documentation for the Backend apps
+
+on:
+  workflow_call:
+    inputs:
+      app-name:
+        required: true
+        type: string
+      environment:
+        required: true
+        type: string
+      work-dir:
+        required: true
+        type: string
+      repo-name:
+        required: true
+        type: string  
+      artifact-name:
+        default: 'xml-reports' 
+        required: false
+        type: string 
+    secrets:
+      SLACK_WEBHOOK_URL:
+        required: true
+
+jobs:
+  poetry-redoc:
+    timeout-minutes: 15
+    runs-on: samba
+    environment: ${{ inputs.environment }}
+    env:
+      PYTHON_VERSION: '3.12'
+    outputs:
+      REDOC_LINKS: ${{ steps.links.outputs.REDOC_LINKS }}  
+      COVERAGE_LINKS: ${{ steps.links.outputs.COVERAGE_LINKS }} 
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4.2.2
+
+      - name: Poetry ci and doc generation
+        id: links
+        uses: SatelCreative/satel-python-poetry-ci-docgen@1.0.7
+        with:       
+          app-name: ${{ inputs.app-name }}
+          environment: ${{ inputs.environment }}
+          work-dir: ${{ inputs.work-dir }}
+          python-version: ${{ env.PYTHON_VERSION }}
+          portal-url: "https://portal.satel.ca/openapi"
+          artifact: ${{ inputs.artifact-name}}
+
+  generate-badges:
+    needs: [poetry-redoc]
+    timeout-minutes: 15
+    # Code coverage action doesn't run on self-hosted runner
+    runs-on: ubuntu-latest 
+    environment: ${{ inputs.environment }}
+    outputs:
+      BADGES: ${{ steps.badges.outputs.BADGES }}
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4.2.2
+
+      - name: Badges generation
+        id: badges
+        uses: SatelCreative/satel-badges-generation@1.0.3
+        with:       
+          app-name: ${{ inputs.app-name }}
+          environment: ${{ inputs.environment }}   
+          artifact: ${{ inputs.artifact-name}}
+
+  update-pr-body: 
+    needs: [poetry-redoc, generate-badges]
+    timeout-minutes: 10
+    if: ${{ github.ref != 'refs/heads/main' }}
+    # myposter-de/update-pr-description action doesn't run on a self-hosted runner
+    runs-on: ubuntu-latest
+    environment: ${{ inputs.environment }}
+    env:
+      REDOC_LINKS: ${{ needs.poetry-redoc.outputs.REDOC_LINKS }}
+      COVERAGE_LINKS: ${{ needs.poetry-redoc.outputs.COVERAGE_LINKS }}
+      BADGE: ${{ needs.generate-badges.outputs.BADGES }}
+      MAIN_BADGE: https://portal.satel.ca/openapi/${{ inputs.repo-name}}/${{ inputs.app-name }}-main.svg 
+      MAIN_COVERAGE: https://portal.satel.ca/openapi/coverage.html?repo=${{ inputs.repo-name}}&branch=main&app=${{ inputs.app-name }}
+    steps:
+        - name: PR body action
+          uses: SatelCreative/satel-update-pr-body@1.0.1
+          with:       
+            app-name: ${{ inputs.app-name }}
+            redoc-links: ${{ env.REDOC_LINKS }}
+            coverage-links: ${{ env.COVERAGE_LINKS }}
+            badge: ${{ env.BADGE }}
+            main-coverage: ${{ env.MAIN_COVERAGE }}
+            main-badge: ${{ env.MAIN_BADGE }}
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  upload-main-badge: 
+    needs: [poetry-redoc, generate-badges]
+    timeout-minutes: 10
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: samba
+    environment: ${{ inputs.environment }}
+    env:
+      BADGE: ${{ needs.generate-badges.outputs.BADGES }}
+    steps:
+        - name: Upload main badge
+          uses: SatelCreative/satel-upload-main-badges@1.0.0
+          with:       
+            app-name: ${{ inputs.app-name }}
+            badge: ${{ env.BADGE }}