chore(docs): readme

Author: Phil-NHS

.artifacts/1/blazor-component-library-package/blazor-component-library-package.zip

@@ -1,18 +1,11 @@
 name: Pull Request Checks
 
-on:
-  pull_request:
-    branches:
-      - '**' 
-      
+on: pull_request
 jobs:
 
-
-        
   branch-name-check:
     name: Enforce Branch Name Convention
     runs-on: ubuntu-latest
-    if: success() || failure()
     steps:
       - name: Validate Branch Name
         run: |
@@ -28,59 +21,77 @@ jobs:
             echo "   build-*, feat-*, fix-*, bugfix-*, hotfix-*, build-*, chore-*, ci-*, docs-*, perf-*, refactor-*, revert-*, style-*, test-*, sample-*, security-*, config-*, bugfix-*, hotfix-*"
             exit 1
           fi
-        #continue-on-error: true
 
-  commitlint:
   # qqqq repo will need branch protection rules and PR Template
+  commitlint:
+    name: commitlint
     runs-on: ubuntu-latest
-    if: success() || failure()
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: wagoid/commitlint-github-action@v5
         with:
           configFile: .commitlintrc.json
-        #continue-on-error: true #we dont want to package etc if bad commits also pre-commit preferred
 
 
-  gitguardian-scan:
-    runs-on: ubuntu-latest
-    if: success() || failure()
-    steps:
-      - uses: actions/checkout@v3
+  # gitguardian-scan:
+    # name: gitguardian
+    # runs-on: ubuntu-latest
+    # #if: success() || failure()
+    # steps:
+      # - uses: actions/checkout@v3
 
-      - name: GitGuardian Scan
-        uses: GitGuardian/gg-shield-action@v1
-        env:
-          GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY  }}
-        #continue-on-error: true # we dont want secrets going further and the keys need to be changed if this is triggered
+      # - name: GitGuardian Scan
+        # uses: GitGuardian/gg-shield-action@v1
+        # env:
+          # GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY  }}
+        # #continue-on-error: true # we dont want secrets going further and the keys need to be changed if this is triggered
 
   Unit-Tests:
+      name: todo unit tests
       runs-on: ubuntu-latest
-      if: success() || failure()
       steps:
         - name: See other project pipeline for Tests
           run: echo "qqqq See other project pipeline for Tests this is a placeholder"
-          #continue-on-error: true
 
 
   E2E-Tests:
+      name: todo e2e tests
       runs-on: ubuntu-latest
-      if: success() || failure()
       steps:
         - name: See other project pipeline for Tests
           run: echo "qqqq See other project pipeline for Tests this is a placeholder"
-          #continue-on-error: true
+
 
   Code-Coverage:
+      name: code coverage
       runs-on: ubuntu-latest
       steps:
         - name: Code Coverage
           run: echo "TODO Code Coverage"
-          #continue-on-error: true
-  
 
-        
-
-        
+  # All-Checks-Passed:
+    # name: all checks passed
+    # runs-on: ubuntu-latest
+    # needs:
+      # - branch-name-check
+      # - commitlint
+      # - gitguardian-scan
+      # - Unit-Tests
+      # - E2E-Tests
+      # - Code-Coverage
+    # #if: ${{ success() }}
+    # steps:
+     # - name: all checks passed steps
+       # run: echo "allow all checks to run incase multiple fails then fail here"
+       
+# wanted to do it like this
+ # Code-Coverage:
+  #    name: code coverage
+  #    runs-on: ubuntu-latest
+      #if: success() || failure()
+  #    steps:
+   #     - name: Code Coverage
+  #        run: echo "TODO Code Coverage"
+          #continue-on-error: true

.github/workflows/dev.yml

@@ -152,29 +152,63 @@ jobs:
           with:
             global-json-file: global.json
 
+        - name: Remove Local PackageSettings (CI Only)
+          run: rm -f PackageSettings.props.local
+        
         - name: Replace local environment variable in nuget config because cant provide it as a parameter
           run: |
+            echo "sed -i \"s|%LocalPackagePath%|$BCL_Source|g\" nuget.config"
             sed -i "s|%LocalPackagePath%|$BCL_Source|g" nuget.config
             sed -i "s|%GITHUB_USERNAME%|$GITHUB_USERNAME|g" nuget.config
             sed -i "s|%GITHUB_PACKAGES_TOKEN%|$PACKAGES_TOKEN |g" nuget.config
-
+        
+        - name: debug BCL_VERSION
+          run: |
+            echo "BCL_VERSION  $BCL_VERSION"
       
         - name: Clean lock files because the newly generated package file will superseed the locks
           run: |
+            echo "Listing packages.lock.json files:"
+            find . -name "packages.lock.json" -type f -print
+            echo ""
+            echo "Deleting packages.lock.json files:"
             find . -name "packages.lock.json" -type f -exec rm -f {} \;
-       
-        - name: Restore NuGet Packages for Specifically the BCL Package Library Project
-          run: dotnet restore TestHostPrerenderWASM/TestHostPrerenderWASM.Client/TestHostPrerenderWASM.Client.csproj      
+          
+            echo "Listing packages.lock.json files:"
+            find . -name "packages.lock.json" -type f -print
         
+        - name: Build Shared Pages
+          run: |
+            dotnet build SharedPages -c Release \
+              /p:BCLVersion=$BCL_VERSION \
+              /p:NupkgOutputPath=$NUPKG_OUTPUT_PATH \
+              /p:UseBCLProjectReference=$USE_BCL_PROJECT_REFERENCE \
+              /p:GhPageRelease=false \
+              /p:LocalPackagePath=$BCL_Source
+              
+        # Blazor client so appsetting in wwwroot and public
+        - name: Modify appsettings.json with hardcoded value
+          run: |
+            jq '.INDEPENDENT_CLIENT_GH_PAGES = "true"' TestHostPrerenderWASM/TestHostPrerenderWASM.Client/wwwroot/appsettings.json > tmp.json && mv tmp.json TestHostPrerenderWASM/TestHostPrerenderWASM.Client/wwwroot/appsettings.json
+
+            
         - name: Create docs directory
           run: mkdir -p docs
-        
+          
+       
+
+      # Print the contents of appsettings.json inside 'TestHostPrerenderWASM.Client' folder
+      # - name: Display appsettings.json content
+        # run: cat TestHostPrerenderWASM/TestHostPrerenderWASM.Client/wwwroot/appsettings.json
+
         - name: Publish client using client release .csproj logic
           run: |
             dotnet publish ./TestHostPrerenderWASM/TestHostPrerenderWASM.Client/TestHostPrerenderWASM.Client.csproj --configuration Release \
-              /p:IsLocalDev=$IS_LOCAL_DEV \
               /p:BCLVersion=$BCL_VERSION \
-              /p:UseBCLProjectReference=$USE_BCL_PROJECT_REFERENCE
+              /p:NupkgOutputPath=$NUPKG_OUTPUT_PATH \
+              /p:UseBCLProjectReference=$USE_BCL_PROJECT_REFERENCE \
+              /p:GhPageRelease=true \
+              /p:LocalPackagePath=$BCL_Source
                   
       
       # No this will be in the release branch that we do a prod wiki host