Merge pull request #16 from liamgold/feature/code-quality-improvements

Code quality improvements and bug fixes

Author: liamgold

.github/RELEASE.md

@@ -0,0 +1,78 @@
+# Release Process
+
+This document describes how to publish a new version to NuGet.
+
+## Prerequisites
+
+1. **Configure Trusted Publishing on NuGet.org** (one-time setup):
+   - Go to: https://www.nuget.org/account/Packages
+   - Find package: `XperienceCommunity.Sustainability`
+   - Click "Manage" → "Trusted publishers" → "Add trusted publisher"
+   - Fill in the form:
+     - **Policy Name**: Any name (e.g., "GitHub Actions Auto-Publish")
+     - **Package Owner**: `liamgold` (should be pre-selected)
+     - **Repository Owner**: `liamgold`
+     - **Repository**: `xperience-community-sustainability`
+     - **Workflow File**: `publish.yml`
+     - **Environment**: (leave blank)
+   - Click "Create"
+
+   This allows GitHub Actions to publish without API keys!
+
+## Publishing a New Version
+
+### 1. Update Version Number
+Edit `src/XperienceCommunity.Sustainability.csproj`:
+```xml
+<Version>2.1.0</Version>
+```
+
+### 2. Commit and Push to Main
+```bash
+git add src/XperienceCommunity.Sustainability.csproj
+git commit -m "Bump version to 2.1.0"
+git push origin main
+```
+
+### 3. Create GitHub Release (creates tag automatically)
+1. Go to: https://github.com/liamgold/xperience-community-sustainability/releases/new
+2. Choose tag: `v2.1.0`
+3. Release title: `v2.1.0`
+4. Add release notes describing changes
+5. Click "Publish release"
+
+### 5. Automatic Publishing
+The GitHub Action will automatically:
+- Build the project
+- Create the NuGet package
+- Publish to NuGet.org
+
+Monitor the workflow at:
+https://github.com/liamgold/xperience-community-sustainability/actions
+
+## Workflow Triggers
+
+- **CI (Build & Test)**: Runs on every push to main and on PRs
+- **Publish to NuGet**: Runs only when a GitHub Release is published
+
+## Version Strategy
+
+Follow [Semantic Versioning](https://semver.org/):
+- **Major** (3.0.0): Breaking changes
+- **Minor** (2.1.0): New features, backward compatible
+- **Patch** (2.0.1): Bug fixes, backward compatible
+
+## Troubleshooting
+
+### "Package already exists" error
+The workflow includes `--skip-duplicate` to handle this gracefully.
+
+### "Authentication failed" or "403 Forbidden"
+Make sure Trusted Publishing is configured correctly on NuGet.org (see Prerequisites above).
+Verify the owner, repository, and workflow name exactly match.
+
+### Want to publish manually?
+```bash
+dotnet pack src/XperienceCommunity.Sustainability.csproj --configuration Release
+dotnet nuget push src/bin/Release/*.nupkg --api-key YOUR_KEY --source https://api.nuget.org/v3/index.json
+```

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build --configuration Release --no-restore
+
+    - name: Run tests (if any)
+      run: dotnet test --no-build --configuration Release --verbosity normal
+      continue-on-error: true  # Continue even if no tests exist

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to NuGet
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build src/XperienceCommunity.Sustainability.csproj --configuration Release --no-restore
+
+    - name: Pack
+      run: dotnet pack src/XperienceCommunity.Sustainability.csproj --configuration Release --no-build --output ./nupkg
+
+    - name: Publish to NuGet using Trusted Publishing
+      run: dotnet nuget push ./nupkg/*.nupkg --source https://api.nuget.org/v3/index.json --skip-duplicate

.gitignore

@@ -416,4 +416,7 @@ FodyWeavers.xsd
 .idea/usage.statistics.xml
 .idea/dictionaries/
 .idea/shelf/
-/examples/DancingGoat/App_Data/playwright
+/examples/DancingGoat/App_Data/playwright
+
+# Claude Code
+.claude/