Merge pull request #36 from ShaunLawrie/prerelease

Update doc site with live examples

.gitattributes

@@ -0,0 +1 @@
+*.cast binary

.github/workflows/build-test-publish.yml

@@ -18,6 +18,8 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Version Bump
         shell: pwsh
         env:
@@ -60,6 +62,8 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Version Bump and Publish
         shell: pwsh
         env:
@@ -107,6 +111,22 @@ jobs:
 
           # Create a gh release for it
           gh release create "v$newVersion-$newPrereleaseTag" --target prerelease --generate-notes --prerelease
+
+          # Publish prerelease docs
+          Install-Module HelpOut -Scope CurrentUser -RequiredVersion 0.5 -Force
+          & .\PwshSpectreConsole.Docs\src\powershell\UpdateDocs.ps1 -NonInteractive -Branch "prerelease"
+          git config --global user.name 'Shaun Lawrie (via GitHub Actions)'
+          git config --global user.email '[email protected]'
+          git add PwshSpectreConsole.Docs/src/content || true
+          git commit -m "[skip ci] Update docs" || true
+          git push || true
+      - name: Deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          workingDirectory: "./PwshSpectreConsole.Docs/dist"
+          command: pages deploy . --project-name pwshspectreconsole --commit-dirty=true --branch=prerelease
       - name: Upload Snapshots
         if: failure()
         uses: actions/upload-artifact@v4

.github/workflows/publish-docs.yml

@@ -16,6 +16,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Build Docs
         shell: pwsh
         run: |

.github/workflows/unit-test-only.yml

@@ -9,14 +9,15 @@ jobs:
   unit-test:
     name: Unit Test
     runs-on: ubuntu-latest
-    if: github.repository_owner != 'ShaunLawrie' || !(github.ref == 'refs/heads/main' && github.ref == 'refs/heads/prerelease')
+    if: github.repository_owner != 'ShaunLawrie' || (github.ref != 'refs/heads/main' && github.ref != 'refs/heads/prerelease')
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
       - name: Unit Test
         shell: pwsh
         run: |
           $ErrorActionPreference = "Stop"
+          Write-Host "Working on ${{ github.ref }}"
           & .\PwshSpectreConsole\Build.ps1
           $env:PSModulePath = @($env:PSModulePath, ".\PwshSpectreConsole\") -join ":"
           $PSVersionTable | Out-Host

.vscode/settings.json

@@ -2,5 +2,6 @@
     "powershell.codeFormatting.preset": "OTBS",
     "editor.formatOnPaste": false,
     "editor.formatOnSave": false,
-    "editor.formatOnType": false
+    "editor.formatOnType": false,
+    "editor.tabSize": 4
 }

PwshSpectreConsole.Docs/astro.config.mjs

@@ -9,7 +9,8 @@ export default defineConfig({
     starlight({
       title: "PwshSpectreConsole",
       editLink: {
-        baseUrl: "https://github.com/ShaunLawrie/PwshSpectreConsole/edit/main/PwshSpectreConsole.Docs/",
+        baseUrl:
+          "https://github.com/ShaunLawrie/PwshSpectreConsole/edit/main/PwshSpectreConsole.Docs/",
       },
       favicon: "/favicon.png",
       customCss: ["./src/tailwind.css"],
@@ -46,5 +47,5 @@ export default defineConfig({
     tailwind({
       applyBaseStyles: false,
     }),
-  ],
+  ]
 });