Updated readme

DFE-Digital · Oct 7, 2024 · 7e71dcd · 7e71dcd
1 parent b064ba6
commit 7e71dcd
Showing 1 changed file with 40 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -19,25 +19,29 @@ For example, if your new library is called "FileService," name the file `build-t
 #### Example Content (Replace with your library name):
 
 ```yaml
-    name: Build DfE.CoreLibs.FileService
-
-    on:
-      push:
-        branches:
-          - main
-        paths:
-          - 'src/DfE.CoreLibs.FileService/**'
-
-    jobs:
-      build-and-test:
-        uses: ./.github/workflows/build-test-template.yml
-        with:
-          project_name: DfE.CoreLibs.FileService
-          project_path: src/DfE.CoreLibs.FileService
-          sonar_project_key: DFE-Digital_corelibs-fileservice
-        secrets:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        name: Build DfE.CoreLibs.FileService
+
+        on:
+          push:
+            branches:
+              - main
+            paths:
+              - 'src/DfE.CoreLibs.FileService/**'
+          pull_request:
+            branches:
+              - main
+            paths:
+              - 'src/DfE.CoreLibs.FileService/**' 
+
+        jobs:
+          build-and-test:
+            uses: ./.github/workflows/build-test-template.yml
+            with:
+              project_name: DfE.CoreLibs.FileService
+              project_path: src/DfE.CoreLibs.FileService
+              run_tests: false
+            secrets:
+              SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 ```
     
 
@@ -53,21 +57,23 @@ For example, name the file `pack-FileService.yml` for your new library.
 #### Example Content (Replace with your library name):
 
 ```yaml
-    name: Pack DfE.CoreLibs.FileService
-    
-    on:
-      workflow_run:
-        workflows: ["Build DfE.CoreLibs.FileService"]
-        types:
-          - completed
-    
-    jobs:
-      build-and-package:
-        uses: ./.github/workflows/nuget-package-template.yml
-        with:
-          project_name: DfE.CoreLibs.FileService
-          project_path: src/DfE.CoreLibs.FileService
-          nuget_package_name: DfE.CoreLibs.FileService
+        name: Pack DfE.CoreLibs.FileService
+
+        on:
+          workflow_run:
+            workflows: ["Build DfE.CoreLibs.FileService"]
+            types:
+              - completed
+
+        jobs:
+          build-and-package:
+            if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'main' && github.event.workflow_run.event != 'pull_request' }}
+            uses: ./.github/workflows/nuget-package-template.yml
+            with:
+              project_name: DfE.CoreLibs.FileService
+              project_path: src/DfE.CoreLibs.FileService
+              nuget_package_name: DfE.CoreLibs.FileService
+
 ```