Feature/33373 create latest url

.github/workflows/checklink.yml

@@ -18,6 +18,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - name: Update Latest URL content
+        shell: pwsh
+        run: |
+          .\createLatest.ps1        
       - name: npm install
         working-directory: ./
         run: |
@@ -40,9 +44,9 @@ jobs:
           config: .htmltest.yml
       - name: Archive htmltest results
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         # Note: Set ACTIONS_RUNTIME_TOKEN env variable to test with nektos/act
         with:
           name: htmltest-report
           path: tmp/.htmltest/htmltest.log
-          retention-days: 7 # Default is 90 days
+          retention-days: 7 # Default is 90 days

.github/workflows/hugo.yml

@@ -43,6 +43,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: recursive
+      - name: Update Latest URL content
+        shell: pwsh
+        run: |
+          .\createLatest.ps1       
       - name: npm install
         working-directory: ./
         run: |

.gitignore

@@ -3,6 +3,8 @@ public/
 resources/
 node_modules/
 tech-doc-hugo
+content/en/docs/latest/
+content/static/latest/
 content/static/**/*.dtmp
 content/static/**/*.bkp
 content/static/**/*.crswap

.htmltest.yml

@@ -25,7 +25,8 @@ IgnoreURLs:
 - "https://blogs.oracle.com/.*"
 - "https://jsonformatter.org/.*"
 - "https://www.newtonsoft.com/.*"
-- "https://.*/gov.uk/.*"
+- "https://.*.gov.uk/.*"
+
 IgnoreDirs:
 - "docs/?.*/_print/"
 - "docs/?.*/_shared/"

createLatest.ps1

@@ -0,0 +1,27 @@
+$Path = ".\config\_default\config.toml"
+$latestName = "latest"
+
+$LatestVersion = (Select-String -Path $Path -Pattern "latest = true" -Context 3, 0) -split "`"" 
+
+# Use $LatestVersion[1] as we know that the version is the first line returned and splitting on " makes it the 2nd index
+$Version = $LatestVersion[1]
+
+# Remove latest folder and contents in docs if it already exists
+if (Test-Path ".\content\en\docs\$latestName"){
+    Remove-Item -LiteralPath ".\content\en\docs\$latestName" -Force -Recurse
+}
+# Create new latest docs folder
+New-Item -ItemType Directory -Path ".\content\en\docs\$latestName\" -Force
+# Copy contents of latest XXXX.X version into latest folder
+Copy-Item -Path ".\content\en\docs\$Version\*" -Destination ".\content\en\docs\$latestName\" -Recurse -Force
+# Replace the title name for the folder to be latest
+(Get-Content .\content\en\docs\latest\_index.md) -replace $Version, "Latest" | Set-Content .\content\en\docs\latest\_index.md
+
+# Remove latest folder and contents in static if it already exists
+if (Test-Path ".\content\static\$latestName"){
+    Remove-Item -LiteralPath ".\content\static\$latestName" -Force -Recurse
+}
+# Create new latest static folder
+New-Item -ItemType Directory -Path ".\content\static\$latestName\" -Force
+# Copy contents of latest XXXX.X version into latest folder
+Copy-Item -Path ".\content\static\$Version\*" -Destination ".\content\static\$latestName\" -Recurse -Force

layouts/partials/navbar-version-selector.html

@@ -5,9 +5,9 @@
 {{- $isRoot := false }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0))}}
 		{{- $isNested = true }}

layouts/partials/section-index.html

@@ -0,0 +1,31 @@
+<div class="section-index">
+    {{ $pages := (where .Site.Pages "Section" .Section).ByWeight }}
+    {{ $pages = (where $pages "Type" "!=" "search") }}
+    {{ $pages = (where $pages "Title" "!=" "Latest") }}
+    {{ $parent := .Page }}
+    {{ if $parent.Params.no_list }}
+    {{/* If no_list is true we don't show a list of subpages */}}
+    {{ else if $parent.Params.simple_list }}
+    {{/* If simple_list is true we show a bulleted list of subpages */}}
+        <ul>
+            {{ range $pages }}
+                {{ if eq .Parent $parent }}
+                    <li><a href="{{ .RelPermalink }}">{{- .Title -}}</a></li>
+                {{ end }}
+            {{ end }}
+        </ul>
+    {{ else }}
+    {{/* Otherwise we show a nice formatted list of subpages with page descriptions */}}
+    <hr class="panel-line">
+        {{ range $pages }}
+            {{ if eq .Parent $parent }}
+                <div class="entry">
+                    <h5>
+                        <a href="{{ .RelPermalink }}">{{- .Title -}}</a>
+                    </h5>
+                    <p>{{ .Description | markdownify }}</p>
+                </div>
+            {{ end }}
+        {{ end }}
+    {{ end }}
+</div>

layouts/shortcodes/ahref.html

@@ -6,9 +6,9 @@
 {{- $link := (printf "%s://%s%s" $url.Scheme $url.Host $url.Path) }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0)) }}
 		{{- $isNested = true }}

layouts/shortcodes/figure.html

@@ -4,9 +4,9 @@
 {{- $versionPath := "" }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0)) }}
 		{{- $isNested = true }}
@@ -18,12 +18,14 @@
     {{ range where .Site.Params.versions "url" $version }}
         {{ $versionPath = .version }}
     {{ end }}
+{{- else if eq $currentVer "/docs/latest/" }}
+    {{ $versionPath = "latest" }}
 {{- else if $currentVer }}
     {{ range where .Site.Params.versions "url" $currentVer }}
         {{ $versionPath = .version }}
     {{ end }}
 {{- else }}
-    {{- /*  use latest as not in a versioned page  */}}
+{{- /*  use latest as not in a versioned page  */}}
     {{ range where .Site.Params.versions "latest" true }}
         {{- $versionPath = .version }}
     {{ end }}

layouts/shortcodes/filelink.html

@@ -4,9 +4,9 @@
 {{- $versionPath := "" }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0)) }}
 		{{- $isNested = true }}
@@ -18,6 +18,8 @@
     {{ range where .Site.Params.versions "url" $version }}
         {{ $versionPath = .version }}
     {{ end }}
+{{- else if eq $currentVer "/docs/latest/" }}
+    {{ $versionPath = "latest" }}
 {{- else if $currentVer }}
     {{ range where .Site.Params.versions "url" $currentVer }}
         {{ $versionPath = .version }}

layouts/shortcodes/image.html

@@ -2,9 +2,9 @@
 {{- $versionPath := "" }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0)) }}
 		{{- $isNested = true }}
@@ -16,6 +16,8 @@
     {{ range where .Site.Params.versions "url" $version }}
         {{ $versionPath = .version }}
     {{ end }}
+{{- else if eq $currentVer "/docs/latest/" }}
+    {{ $versionPath = "latest" }}
 {{- else if $currentVer }}
     {{ range where .Site.Params.versions "url" $currentVer }}
         {{ $versionPath = .version }}

layouts/shortcodes/section.html

@@ -4,9 +4,9 @@
 */}}
 {{ $filePath := .Get 0 }}
 {{- /* Get the current version. */}}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 {{- end }}
 {{ $page := .Site.GetPage (printf "%s%s%s" $currentVer "_shared" $filePath) }}

layouts/shortcodes/url.html

@@ -7,9 +7,9 @@
 {{- $link := (printf "%s://%s%s" $url.Scheme $url.Host $url.Path) }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0) ) }}
 		{{- $isNested = true }}

layouts/shortcodes/version.html

@@ -4,9 +4,9 @@
 */}}
 {{- /* Get the current version, setting to latest if not in a versioned page. */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (not $currentVer) }}
         {{ range where .Site.Params.versions "latest" true }}

layouts/shortcodes/workinprogress.html

@@ -1,15 +1,17 @@
 {{- $versionPath := "" }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0)) }}
 		{{- $isNested = true }}
 	{{- end }}
 {{- end }}
-{{- if $currentVer }}
+{{- if eq $currentVer "/docs/latest/" }}
+    {{ $versionPath = "latest" }}
+{{- else if $currentVer }}
     {{ range where .Site.Params.versions "url" $currentVer }}
         {{ $versionPath = .version }}
     {{ end }}

layouts/shortcodes/youtube.html

@@ -1,9 +1,9 @@
 {{- $versionPath := "" }}
 {{- /* Get the current version, and whether the website is currently nested (has /docs prepended). */}}
 {{- $isNested := false }}
-{{- $currentVer := index (findRE `^\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+{{- $currentVer := index (findRE `^\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 {{- if (not $currentVer) }}
-	{{- $currentVer = index (findRE `^\/docs\/docs\/[0-9\.]*\/` .Page.RelPermalink 1) 0 }}
+	{{- $currentVer = index (findRE `^\/docs\/docs\/([0-9\.]*|latest)\/` .Page.RelPermalink 1) 0 }}
 	{{- $currentVer = replaceRE `^\/docs` "" $currentVer 1 }}
 	{{- if (or $currentVer (index (findRE `^\/docs\/[^\/]*\/` .Page.RelPermalink 1) 0)) }}
 		{{- $isNested = true }}