chore: Overall improvements to CI

nickevansuk · nickevansuk · commit 113086d1a46e · 2022-07-15T17:36:43.000+01:00
diff --git a/.github/workflows/create-data-model-pr.yaml b/.github/workflows/create-data-model-pr.yaml
@@ -43,11 +43,9 @@ jobs:
         
       - name: git stash if material changes have not been made
         # When considering whether it's worth making a PR, ignore the following:
-        # - The dataset-site-template version number updating within the template in DatasetSiteMustacheTemplate.cs (affects four lines)
-        # - The dataset-site-template version number updating within the template in README.md (affects three lines)
-        # - Any updates to the package.json or package-lock.json files in OpenActive.DatasetSite.NET.Generator (not worth creating a PR JUST for these if the new version did not have any implications)
+        # - Any updates to the package.json or package-lock.json files in OpenActive.DatasetSite.NET.Generator (not worth creating a PR JUST for these if the template itself has not been updated)
         # git stashing if no material changes allows the next step to close the PR if one is already open
-        run: if [ "$(git diff --numstat | grep -vc '^4\s.*DatasetSiteMustacheTemplate\.cs\|3\s.*README\.md\|.*package\.json\|.*package-lock\.json$')" -eq "0" ]; then git stash; else echo "Material changes found"; fi
+        run: if [ "$(git diff --numstat | grep -vc '^.*package\.json\|.*package-lock\.json$')" -eq "0" ]; then git stash; else echo "Material changes found"; fi
         working-directory: ./
 
       - name: Create Pull Request
diff --git a/OpenActive.DatasetSite.NET.Generator/app.js b/OpenActive.DatasetSite.NET.Generator/app.js
@@ -4,10 +4,13 @@ var request = require('sync-request');
 var path = require('path');
 const { getModels, getEnums, getMetaData } = require('@openactive/data-models');
 const { getDatasetSiteTemplateSync, getStaticAssetsArchiveUrl, getStaticAssetsVersion } = require('@openactive/dataset-site-template');
+const { exit } = require('process');
 
 const DATA_MODEL_OUTPUT_DIR = "../OpenActive.DatasetSite.NET/metadata/";
 const SOLUTION_README_FILE_PATH = "../README.md";
+const VERSION_FILE_PATH = "../version.json";
 
+updateVersionFile();
 removeFiles()
 generateDatasetSiteMustacheTemplate();
 generateOpportunityTypes();
@@ -30,6 +33,20 @@ function updateReadme() {
     }));
 }
 
+function updateVersionFile() {
+    // Align version number major version to version of template
+    updateFile(VERSION_FILE_PATH, x => {
+        const json = JSON.parse(x);
+        const newVersion = `${getStaticAssetsVersion()}.0`;
+        if (json.version == newVersion) {
+            console.log("NO MAJOR VERSION CHANGE DETECTED: Hence no update is required. Updates to the template within dataset-site-template must come with a major version bump");
+            exit();
+        }
+        json.version = newVersion;
+        return JSON.stringify(json, null, 2);
+    });
+}
+
 function renderMustacheTemplateFile(singleFileTemplate, cspTemplate) {
     return `
 namespace OpenActive.DatasetSite.NET
diff --git a/OpenActive.DatasetSite.NET.Generator/package-lock.json b/OpenActive.DatasetSite.NET.Generator/package-lock.json
diff --git a/OpenActive.DatasetSite.NET.Generator/package.json b/OpenActive.DatasetSite.NET.Generator/package.json
@@ -12,7 +12,7 @@
   "license": "MIT",
   "dependencies": {
     "@openactive/data-models": "^2.0.285",
-    "@openactive/dataset-site-template": "^1.0.19",
+    "@openactive/dataset-site-template": "^3.0.0",
     "fs-extra": "^7.0.1",
     "sync-request": "^6.0.0"
   }
diff --git a/OpenActive.DatasetSite.NET/metadata/DatasetSiteMustacheTemplate.cs b/OpenActive.DatasetSite.NET/metadata/DatasetSiteMustacheTemplate.cs
@@ -6,7 +6,7 @@ public static class DatasetSiteMustacheTemplate
         public const string SingleTemplateFileContent = @"
 <!DOCTYPE HTML>
 <!--
-  OpenActive Dataset Site Template version 1.0.19, from https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite.mustache
+  OpenActive Dataset Site Template version 3, from https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite.mustache
 -->
 <!--
   Design: Identity by HTML5 UP
@@ -1360,11 +1360,11 @@ @media screen and (max-width: 360px) {
         public const string CspCompatibleTemplateFileContent = @"
 <!DOCTYPE HTML>
 <!--
-  OpenActive Dataset Site Template version 1.0.19, from https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.mustache
+  OpenActive Dataset Site Template version 3, from https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.mustache
   
-  This HTML file must reference a self-hosted 'datasetsite.styles.v1.0.19.css' file, co-located with the rest
+  This HTML file must reference a self-hosted 'datasetsite.styles.v3.css' file, co-located with the rest
   of the static assets from the following archive:
-  https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.static.zip
+  https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.static.zip
 -->
 <!--
   Design: Identity by HTML5 UP
@@ -1407,21 +1407,21 @@ For openactive.io
     </script>
     
     <!--
-      This stylesheet href must reference a self-hosted 'datasetsite.styles.v1.0.19.css' file in
+      This stylesheet href must reference a self-hosted 'datasetsite.styles.v3.css' file in
       the same directory as the other static assets sourced from the following archive:
-      https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.static.zip
+      https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.static.zip
     -->
-    <link rel=""stylesheet"" href=""{{{staticAssetsPathUrl}}}/datasetsite.styles.v1.0.19.css"" crossorigin=""anonymous"">
+    <link rel=""stylesheet"" href=""{{{staticAssetsPathUrl}}}/datasetsite.styles.v3.css"" crossorigin=""anonymous"">
 
 </head>
 <body id=""booking"" background=""{{backgroundImage.url}}"">
     <table class=""always-hidden"" bgcolor=""#FFFFFF"" width=""100%"" height=""500px""><tr><td align=""center"">
       <p></p>
       <p><large><strong>Error: Static Assets Not Found</strong><large></p>
       <p>This HTML page must reference self-hosted static assets located at the relative or absolute path configured by ""staticAssetsPathUrl"" in the mustache template source data.</p>
-      <p>""staticAssetsPathUrl"" is currently set to ""{{staticAssetsPathUrl}}"", and this page has failed to access this file: <pre>{{staticAssetsPathUrl}}/datasetsite.styles.v1.0.19.css</pre></p>
+      <p>""staticAssetsPathUrl"" is currently set to ""{{staticAssetsPathUrl}}"", and this page has failed to access this file: <pre>{{staticAssetsPathUrl}}/datasetsite.styles.v3.css</pre></p>
       <p>Please ensure that the assets at this location exactly match those in
-      <a href=""https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.static.zip"">datasetsite-csp.static.zip version 1.0.19</a>.</p>
+      <a href=""https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.static.zip"">datasetsite-csp.static.zip version 3</a>.</p>
       <p></p>
       <p>See the <a href=""https://github.com/openactive/dataset-site-template"">""CSP compatible template"" documentation</a> for more information</p>
       <p></p>
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ Simply call one of the Render methods detailed below to output self-contained HT
 
 Returns a string corresponding to the compiled HTML, based on an embedded version of `datasetsite.mustache`, the provided `settings`, and `supportedOpportunityTypes`.
 
-If `staticAssetsPathUrl` is provided, the [CSP-compatible template](https://developer.openactive.io/publishing-data/dataset-sites#template-hosting-options) is rendered. In this case you must ensure that you are serving the contents of [CSP compatible static assets archive v1.0.19](https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.static.zip) at this location.
+If `staticAssetsPathUrl` is provided, the [CSP-compatible template](https://developer.openactive.io/publishing-data/dataset-sites#template-hosting-options) is rendered. In this case you must ensure that you are serving the contents of [CSP compatible static assets archive v3](https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.static.zip) at this location.
 
 `supportedOpportunityTypes` must be a `List<OpportunityType>`, which auto-generates the metadata associated which each feed using best-practice values.
 
@@ -133,7 +133,7 @@ var dataFeedDescriptions = new List<string> {
 };
 ```
 
-If `staticAssetsPathUrl` is provided, the [CSP-compatible template](https://developer.openactive.io/publishing-data/dataset-sites#template-hosting-options) is rendered. In this case you must ensure that you are serving the contents of [CSP compatible static assets archive v1.0.19](https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.static.zip) at this location.
+If `staticAssetsPathUrl` is provided, the [CSP-compatible template](https://developer.openactive.io/publishing-data/dataset-sites#template-hosting-options) is rendered. In this case you must ensure that you are serving the contents of [CSP compatible static assets archive v3](https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.static.zip) at this location.
 
 
 #### Example
@@ -227,7 +227,7 @@ Returns a string corresponding to the compiled HTML, based on an embedded versio
 
 The `dataset` argument must be an object of type `OpenActive.NET.Dataset`, and must contain the properties required to render the dataset site.
 
-If `staticAssetsPathUrl` is provided, the [CSP-compatible template](https://developer.openactive.io/publishing-data/dataset-sites#template-hosting-options) is rendered. In this case you must ensure that you are serving the contents of [CSP compatible static assets archive v1.0.19](https://unpkg.com/@openactive/dataset-site-template@1.0.19/dist/datasetsite-csp.static.zip) at this location.
+If `staticAssetsPathUrl` is provided, the [CSP-compatible template](https://developer.openactive.io/publishing-data/dataset-sites#template-hosting-options) is rendered. In this case you must ensure that you are serving the contents of [CSP compatible static assets archive v3](https://unpkg.com/@openactive/dataset-site-template@3.0.0/dist/datasetsite-csp.static.zip) at this location.
 
 #### Example
 

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`"license": "MIT",`
`13`	`13`	`"dependencies": {`
`14`	`14`	`"@openactive/data-models": "^2.0.285",`
`15`		`- "@openactive/dataset-site-template": "^1.0.19",`
	`15`	`+ "@openactive/dataset-site-template": "^3.0.0",`
`16`	`16`	`"fs-extra": "^7.0.1",`
`17`	`17`	`"sync-request": "^6.0.0"`
`18`	`18`	`}`