Add release pipeline

.github/workflows/release.yml

@@ -0,0 +1,120 @@
+name: Release WordAI Add-in
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: windows-latest
+    env:
+      BUILD_CONFIGURATION: Release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Prepare build metadata
+        shell: pwsh
+        run: |
+          $tag = $env:GITHUB_REF_NAME
+          if (-not $tag) { throw "GITHUB_REF_NAME is not set." }
+          if ($tag.StartsWith("v")) { $tag = $tag.Substring(1) }
+          if ($tag -notmatch '^\d+(\.\d+){2,3}$') {
+              throw "Tags must follow v<major.minor.patch[.revision]>."
+          }
+          $segments = $tag.Split(".")
+          if ($segments.Count -eq 3) {
+              $appVersion = "$tag.0"
+          } else {
+              $appVersion = $tag
+          }
+          $publishDir = Join-Path $env:RUNNER_TEMP "publish"
+          if (-not (Test-Path $publishDir)) {
+              New-Item -ItemType Directory -Path $publishDir | Out-Null
+          }
+          if (-not $publishDir.EndsWith("\\")) {
+              $publishDir += "\\"
+          }
+          $packageName = "WordAI-$tag.zip"
+          $packagePath = Join-Path $env:RUNNER_TEMP $packageName
+          "RELEASE_VERSION=$tag" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+          "APPLICATION_VERSION=$appVersion" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+          "PUBLISH_DIR=$publishDir" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+          "RELEASE_PACKAGE=$packagePath" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+      - name: Restore NuGet packages
+        run: nuget restore WordAI.VSTO/WordAI.VSTO.csproj -SolutionDirectory .
+
+      - name: Run unit tests
+        shell: pwsh
+        run: |
+          $env:DOTNET_ROLL_FORWARD = 'Major'
+          dotnet test WordAI.Tests/WordAI.Tests.csproj
+
+      - name: Import signing certificate
+        shell: pwsh
+        env:
+          PFX_BASE64: ${{ secrets.WORDAI_CODE_SIGNING_PFX }}
+          PFX_PASSWORD: ${{ secrets.WORDAI_CODE_SIGNING_PASSWORD }}
+        run: |
+          if (-not $env:PFX_BASE64) { throw "WORDAI_CODE_SIGNING_PFX is not configured." }
+          if (-not $env:PFX_PASSWORD) { throw "WORDAI_CODE_SIGNING_PASSWORD is not configured." }
+          $pfxPath = Join-Path $env:RUNNER_TEMP 'wordai-signing.pfx'
+          [IO.File]::WriteAllBytes($pfxPath, [Convert]::FromBase64String($env:PFX_BASE64))
+          $securePassword = ConvertTo-SecureString -String $env:PFX_PASSWORD -AsPlainText -Force
+          $cert = Import-PfxCertificate -FilePath $pfxPath -CertStoreLocation Cert:\CurrentUser\My -Password $securePassword
+          if (-not $cert) { throw "Failed to import signing certificate." }
+          "CERT_THUMBPRINT=$($cert.Thumbprint)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+          Remove-Item $pfxPath -Force
+
+      - name: Publish add-in
+        working-directory: WordAI.VSTO
+        shell: pwsh
+        run: |
+          $msbuild = "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\Bin\MSBuild.exe"
+          $publishDir = $env:PUBLISH_DIR
+          $arguments = @(
+              "WordAI.VSTO.csproj",
+              "/target:Publish",
+              "/p:Configuration=$env:BUILD_CONFIGURATION",
+              "/p:TargetFrameworkVersion=v4.8",
+              "/p:PublishDir=$publishDir",
+              "/p:ApplicationVersion=$env:APPLICATION_VERSION",
+              "/p:ApplicationRevision=0",
+              "/p:ManifestCertificateThumbprint=$env:CERT_THUMBPRINT",
+              "/p:ManifestKeyFile="
+          )
+          & $msbuild @arguments
+
+      - name: Create release package
+        shell: pwsh
+        run: |
+          $publishDir = $env:PUBLISH_DIR
+          $packagePath = $env:RELEASE_PACKAGE
+          if (Test-Path $packagePath) { Remove-Item $packagePath -Force }
+          Compress-Archive -Path "$publishDir*" -DestinationPath $packagePath -Force
+
+      - name: Upload installer artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: WordAI-${{ env.RELEASE_VERSION }}
+          path: ${{ env:RELEASE_PACKAGE }}
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: WordAI ${{ env:RELEASE_VERSION }}
+          generate_release_notes: true
+          files: ${{ env:RELEASE_PACKAGE }}
+
+      - name: Remove imported certificate
+        if: always()
+        shell: pwsh
+        run: |
+          if ($env:CERT_THUMBPRINT) {
+              Remove-Item -Path "Cert:\CurrentUser\My\$($env:CERT_THUMBPRINT)" -ErrorAction SilentlyContinue
+          }

AGENTS.md

@@ -3,4 +3,7 @@
 - Use four-space indentation and LF line endings.
 - Run tests with `DOTNET_ROLL_FORWARD=Major dotnet test WordAI.Tests/WordAI.Tests.csproj` before committing.
 - The `WordAI.VSTO` project targets .NET Framework 4.8 and requires Visual Studio on Windows; avoid building it on Linux.
-- Update this file and the README when build or test instructions change.
+- Tag releases as `vX.Y.Z` and push the tag to trigger the GitHub Actions release workflow.
+- Keep the signing secrets (`WORDAI_CODE_SIGNING_PFX`, `WORDAI_CODE_SIGNING_PASSWORD`) current in the repository settings.
+- Update this file, the README, `CONTRIB.md`, and `RELEASE.md` when build or test instructions change.
+

CONTRIB.md

@@ -0,0 +1,16 @@
+# Contributor Guide
+
+## Local Setup
+
+- Use four-space indentation and LF line endings.
+- Restore NuGet packages with `nuget restore WordAI.VSTO/WordAI.VSTO.csproj -SolutionDirectory .` if Visual Studio does not do it automatically.
+
+## Testing
+
+- Run the prompt manager unit tests with `DOTNET_ROLL_FORWARD=Major dotnet test WordAI.Tests/WordAI.Tests.csproj`.
+
+## Building the VSTO Add-in
+
+- Build on a Windows machine with Visual Studio 2022 or later and the .NET Framework 4.8 tooling installed.
+- Use the `Release` configuration to generate the ClickOnce output in `WordAI.VSTO/bin/Release/`.
+

README.md

@@ -82,13 +82,5 @@ The GitHub workflow builds the VSTO add-in using a self-signed certificate gener
 
 WordAI is definitely BETA software. I use it and "it works on my machine" - Install at your own risks, and reach out if you would like to collaborate for improvements !
 
-## Development
-
-The repository includes unit tests for the prompt management features. If your environment only has a newer .NET SDK installed, you can run the tests with:
-
-```bash
-DOTNET_ROLL_FORWARD=Major dotnet test WordAI.Tests/WordAI.Tests.csproj
-```
-
-Building the VSTO add-in itself requires Windows, Visual Studio and the .NET Framework 4.8 tooling.
+See `CONTRIB.md` for local build and test instructions, and `RELEASE.md` for publishing guidance.
 

RELEASE.md

@@ -0,0 +1,16 @@
+# Release Guide
+
+## Automated Release Workflow
+
+- The `Release WordAI Add-in` GitHub Actions workflow runs on tags that match `v*`.
+- It restores NuGet packages, runs unit tests, publishes the ClickOnce installer with a signing certificate, and zips the output (`setup.exe`, the `.vsto` manifest, and `Application Files/`).
+- Store the base64-encoded `.pfx` in the `WORDAI_CODE_SIGNING_PFX` secret and its password in `WORDAI_CODE_SIGNING_PASSWORD` so the workflow can import the certificate during the build.
+- Tag versions in `major.minor.patch` form (for example `v1.2.3`). The workflow pads the ClickOnce `ApplicationVersion` with a `.0` revision segment when necessary.
+
+## Publishing a Release
+
+1. Push the commit you want to release to GitHub.
+2. Create an annotated tag such as `v1.2.3` that reflects the desired version number.
+3. Push the tag (`git push origin v1.2.3`).
+4. Monitor the `Release WordAI Add-in` workflow run and confirm that the generated GitHub release includes the packaged installer.
+