RC TO CI

.github/azure-pipeline-webui-ci.yml

@@ -51,6 +51,57 @@ jobs:
     inputs:
       command: restore
       projects: $(BuildParameters.RestoreBuildProjects)
+      # Step 1: Get the version tag from the repository
+- script: |
+    echo "Extracting version from Git tag: $(versionTag)"
+    VERSION=$(echo $(versionTag) | sed 's/^v//')
+    echo "VERSION=$VERSION" >> $(Build.ArtifactStagingDirectory)/version.txt
+  displayName: 'Extract version tag'
+
+# Step 2: Update AssemblyVersion in Web UI .csproj
+- powershell: |
+    $versionFile = "$(Build.ArtifactStagingDirectory)/version.txt"
+    $version = Get-Content $versionFile
+    $version = $version.Trim()
+
+    # Path to your .csproj file (adjust if necessary)
+    $csprojFile = "$(Build.SourcesDirectory)\LearningHub.Nhs.WebUI\LearningHub.Nhs.WebUI.csproj"
+
+    Write-Host "Updating AssemblyVersion and FileVersion and Version  in $csprojFile to $version"
+
+    # Load the .csproj XML file
+    [xml]$csprojXml = Get-Content -Path $csprojFile
+
+    # Update the AssemblyVersion and FileVersion
+    $csprojXml.Project.PropertyGroup.AssemblyVersion = $version
+    $csprojXml.Project.PropertyGroup.FileVersion = $version
+    $csprojXml.Project.PropertyGroup.Version = $version
+
+    # Save the updated .csproj file
+    $csprojXml.Save($csprojFile)
+  displayName: 'Update AssemblyVersion in WebUI .csproj'
+  # Step 2: Update AssemblyVersion in Admin UI .csproj
+- powershell: |
+    $versionFile = "$(Build.ArtifactStagingDirectory)/version.txt"
+    $version = Get-Content $versionFile
+    $version = $version.Trim()
+
+    # Path to your .csproj file (adjust if necessary)
+    $csprojFile = "$(Build.SourcesDirectory)\AdminUI\LearningHub.Nhs.AdminUI\LearningHub.Nhs.AdminUI.csproj"
+
+    Write-Host "Updating AssemblyVersion and FileVersion and Version  in $csprojFile to $version"
+
+    # Load the .csproj XML file
+    [xml]$csprojXml = Get-Content -Path $csprojFile
+
+    # Update the AssemblyVersion and FileVersion
+    $csprojXml.Project.PropertyGroup.AssemblyVersion = $version
+    $csprojXml.Project.PropertyGroup.FileVersion = $version
+    $csprojXml.Project.PropertyGroup.Version = $version
+
+    # Save the updated .csproj file
+    $csprojXml.Save($csprojFile)
+  displayName: 'Update AssemblyVersion in AdminUI .csproj'
   - task: DotNetCoreCLI@2
     displayName: Build
     inputs:

.github/dependabot.yml

@@ -0,0 +1,56 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "nuget" 
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 10
+    target-branch: "Automatic_version_update_dependabot"
+    ignore:
+      # Ignore updates to packages that start with 'Wildcards'
+      - dependency-name: "Microsoft.FeatureManagement.AspNetCore*"
+      - dependency-name: "LearningHub.Nhs.Models*"
+      - dependency-name: "LearningHub.Nhs.Caching*"
+      - dependency-name: "elfhHub.Nhs.Models*"   
+      - dependency-name: "linqtotwitter*"         
+      # Ignore some updates to the package
+      - dependency-name: "Microsoft.VisualStudio.Web.CodeGeneration.Design"
+        versions: [">7.0.0"]
+      - dependency-name: "Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation"
+        versions: [">7.0.0"]
+      - dependency-name: "Microsoft.AspNetCore.Mvc.Testing"
+        versions: [">7.0.0"]
+      - dependency-name: "Selenium.WebDriver.ChromeDriver"
+        versions: ">=113.0.5672.1278" # Recommended version
+      # For all packages, ignore all patch updates
+      #- dependency-name: "*"
+      #  update-types: ["version-update:semver-patch"]
+
+  # Configuration for npm WebUI
+  - package-ecosystem: "npm" 
+    directory: "LearningHub.Nhs.WebUI/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    target-branch: "Automatic_version_update_dependabot"
+    #  - "dependencies"
+    open-pull-requests-limit: 10
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]
+
+  # Configuration for npm AdminUI
+  - package-ecosystem: "npm" 
+    directory: "AdminUI/LearningHub.Nhs.AdminUI/" # Location of package manifests
+    schedule:
+      interval: "daily"
+    target-branch: "Automatic_version_update_dependabot"
+    #  - "dependencies"
+    open-pull-requests-limit: 10
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]

.github/pull_request_template.md

@@ -1,25 +1,25 @@
 ### JIRA link
-_TD-###_
+[TD-####](https://hee-tis.atlassian.net/browse/TD-####)
 
 ### Description
-_Describe what has changed and how that will affect the app. If relevant, add references to the resources you used. Use this as your opportunity to highlight anything odd and give people context around particular decisions._
+_Describe what has changed and how that will affect the app. If relevant, add links to any sources/documentation you used. Highlight anything unusual and give people context around particular decisions._
 
 ### Screenshots
-_Attach screenshots on mobile, tablet and desktop._
+_Paste screenshots for all views created or changed: mobile, tablet and desktop, wave analyser showing no errors._
 
 -----
 ### Developer checks
 (Leave tasks unticked if they haven't been appropriate for your ticket.)
 
 I have:
-- [ ] Run the formatter and made sure there are no IDE errors
-- [ ] Written appropriate unit tests for the changes, including:
-	- accessibility tests for new views
-	- tests for new controller methods
-	- tests for new or modified API endpoints
-- [ ] Manually tested my work with and without JavaScript
-- [ ] Tested any Views or partials created or changed with [Wave Chrome plugin](https://chrome.google.com/webstore/detail/wave-evaluation-tool/jbbplnpkjmmeebjpijfedlgcdilocofh/related) and addressed any valid accessibility issues
-- [ ] Updated/added documentation in [Confluence](https://hee-tis.atlassian.net/wiki/spaces/TP/pages/3477930003/Learning+Hub) and/or [GitHub Readme](https://github.com/TechnologyEnhancedLearning/LearningHub.Nhs.UserApi/blob/master/README.md). List of documentation links added/changed:
+- [ ] Run the IDE auto formatter on all files I’ve worked on and made sure there are no IDE errors relating to them
+- [ ] Written or updated tests for the changes (accessibility ui tests for views, tests for controller, data services, services, view models created or modified) and made sure all tests are passing
+- [ ] Manually tested my work with and without JavaScript (adding notes where functionality requires JavaScript)
+- [ ] Tested any Views or partials created or changed with [Wave Chrome plugin](https://chrome.google.com/webstore/detail/wave-evaluation-tool/jbbplnpkjmmeebjpijfedlgcdilocofh/related). Addressed any valid accessibility issues and documented any invalid errors
+- [ ] Updated my Jira ticket with testing notes, including information about other parts of the system that were touched as part of the MR and need  to be tested to ensure nothing is broken
+- [ ] Scanned over my pull request in GitHub and addressed any warnings from the GitHub Build and Test checks in the GitHub PR ‘Files Changed’ tab
+Either:
+- [ ] Documented my work in [Confluence](https://hee-tis.atlassian.net/wiki/spaces/TP/pages/3461087233/Development), updating any business rules applied or modified. Updated GitHub readme/documentation for the repository if appropriate. List of documentation links added/changed:
   - [doc_1_here](link_1_here)
-- [ ] Updated my Jira ticket with information about other parts of the system that were touched as part of the MR and have to be sanity tested to ensure nothing is broken
-- [ ] Scanned over my pull request in GitHub and addressed any warnings from the GitHub Build and Test checks.
+Or:
+- [ ] Confirmed that none of the work that I have undertaken requires any updates to documentation

.github/workflows/auto-merge.yml

@@ -0,0 +1,183 @@
+name: Auto Merge Dependabot PRs
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  auto-merge:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Set up GitHub CLI
+        run: |
+          # Install GitHub CLI (gh)
+          sudo apt-get update
+          sudo apt-get install gh
+
+          # Authenticate GitHub CLI using the provided token
+          echo ${{ secrets.GITHUB_TOKEN }} | gh auth login --with-token
+
+      - name: Wait for CI workflow to pass (Ensure CI workflow succeeded)
+        id: wait_for_ci
+        run: |
+           # Get the PR number from the GitHub event
+            PR_NUMBER=${{ github.event.pull_request.number }}
+            echo "Checking CI status for PR #$PR_NUMBER"
+
+            # Define the maximum wait time (in seconds) and the polling interval (in seconds)
+            MAX_WAIT_TIME=1800  # 30 minutes
+            POLL_INTERVAL=10   # Check every 10 seconds
+
+            # Initialize a timer
+            elapsed_time=0
+
+            # Poll CI status until all checks are completed
+            while true; do
+              # Fetch the status check rollup for the PR
+              CI_STATUS=$(gh pr view $PR_NUMBER --json statusCheckRollup)
+
+              # Log the fetched response
+              echo "CI Status Response: $CI_STATUS"
+
+              # Parse the checks and check their status
+              ALL_COMPLETED=true
+              ALL_CHECKS_PASSED=true
+
+              for check in $(echo "$CI_STATUS" | jq -r '.statusCheckRollup[] | @base64'); do
+                _jq() {
+                  echo "${check}" | base64 --decode | jq -r "${1}"
+                }
+
+                status=$(_jq '.status')
+                conclusion=$(_jq '.conclusion')
+                check_name=$(_jq '.name')
+
+                # Log check details
+                echo "Check: $check_name, Status: $status, Conclusion: $conclusion"
+                 if [[ "$check_name" == "auto-merge" ]]; then
+                    echo "Skipping 'auto-merge' workflow check to prevent self-referencing."
+                    continue
+                  fi
+
+                # If any check is still queued, set ALL_COMPLETED to false
+                if [[ "$status" == "QUEUED" ]]; then
+                  ALL_COMPLETED=false
+                fi
+
+                # If any check is still in progress, set ALL_COMPLETED to false
+                if [[ "$status" == "IN_PROGRESS" ]]; then
+                  ALL_COMPLETED=false
+                fi
+
+                # If any completed check has failed, set ALL_CHECKS_PASSED to false
+                if [[ "$status" == "COMPLETED" && "$conclusion" != "SUCCESS" ]]; then
+                  ALL_CHECKS_PASSED=false
+                fi
+              done
+
+              # Break the loop if all checks are completed
+              if [[ "$ALL_COMPLETED" == true ]]; then
+                break
+              fi
+
+              # Wait for the next polling interval
+              echo "Waiting for checks to complete... ($elapsed_time/$MAX_WAIT_TIME seconds elapsed)"
+              sleep $POLL_INTERVAL
+              elapsed_time=$((elapsed_time + POLL_INTERVAL))
+
+              # Exit if the maximum wait time is exceeded
+              if [[ "$elapsed_time" -ge "$MAX_WAIT_TIME" ]]; then
+                echo "Timed out waiting for CI checks to complete."
+                exit 1
+              fi
+            done
+
+            # Final check: Ensure all CI checks passed
+            if [[ "$ALL_CHECKS_PASSED" == false ]]; then
+              echo "One or more CI checks failed. Aborting merge."
+              exit 1
+            fi
+
+            echo "All CI checks passed successfully."
+
+
+      - name: Check Target Branch and PR Title
+        id: check_branch
+        run: |
+          PR_TITLE='${{ github.event.pull_request.title }}'
+          echo "Original PR Title: $PR_TITLE"
+
+          # Escape problematic quotes
+          ESCAPED_TITLE=$(echo "$PR_TITLE" | sed 's/"/\\"/g')
+          echo "Escaped PR Title: $ESCAPED_TITLE"
+
+          if [[ "$ESCAPED_TITLE" =~ ([0-9]+\.[0-9]+\.[0-9]+).*to.*([0-9]+\.[0-9]+\.[0-9]+) ]]; then
+            # Extract version numbers
+            OLD_VERSION="${BASH_REMATCH[1]}"
+            NEW_VERSION="${BASH_REMATCH[2]}"
+            echo "Version change detected: $OLD_VERSION to $NEW_VERSION"
+
+            # Split version into major, minor, patch components
+            OLD_MAJOR=$(echo "$OLD_VERSION" | cut -d '.' -f1)
+            OLD_MINOR=$(echo "$OLD_VERSION" | cut -d '.' -f2)
+            OLD_PATCH=$(echo "$OLD_VERSION" | cut -d '.' -f3)
+
+            NEW_MAJOR=$(echo "$NEW_VERSION" | cut -d '.' -f1)
+            NEW_MINOR=$(echo "$NEW_VERSION" | cut -d '.' -f2)
+            NEW_PATCH=$(echo "$NEW_VERSION" | cut -d '.' -f3)
+
+            # Check if it's a minor or patch update
+            if [[ "$OLD_MAJOR" == "$NEW_MAJOR" ]] && [[ "$OLD_MINOR" == "$NEW_MINOR" ]] && [[ "$NEW_PATCH" -gt "$OLD_PATCH" ]]; then
+              echo "Patch update detected"
+              echo "should_merge=true" >> $GITHUB_ENV
+            elif [[ "$OLD_MAJOR" == "$NEW_MAJOR" ]] && [[ "$NEW_MINOR" -gt "$OLD_MINOR" ]]; then
+              echo "Minor update detected"
+              echo "should_merge=true" >> $GITHUB_ENV
+            else
+              echo "No minor/patch update detected"
+              echo "should_merge=false" >> $GITHUB_ENV
+            fi
+          else
+            echo "No version change detected"
+            echo "should_merge=false" >> $GITHUB_ENV
+          fi
+
+      - name: Debug Context
+        uses: actions/github-script@v6
+        with:
+          script: |
+            console.log("Target branch:", context.payload.pull_request.base.ref);
+
+      - name: Check if Should Merge
+        run: |
+          echo "DEBUG: should_merge=${{ env.should_merge }}"
+          if [[ "${{ env.should_merge }}" == "true" ]] && [[ "${{ github.event.pull_request.base.ref }}" == "Automatic_version_update_dependabot" ]]; then
+            echo "DEBUG: should merge PR"
+            echo "should_merge=true" >> $GITHUB_ENV
+          else
+            echo "DEBUG: skip merge"
+            echo "should_merge=false" >> $GITHUB_ENV
+          fi
+
+      - name: Merge Pull Request
+        if: ${{ env.should_merge == 'true' }}
+        uses: actions/github-script@v6
+        with:
+          script: |
+            github.rest.pulls.merge({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.payload.pull_request.number,
+              merge_method: "squash"
+            });