ci: Fix versioning in package deployment (v3)

.github/workflows/deploy-package.yml

@@ -1,6 +1,22 @@
 name: Deploy NuGet package
 
+# Version format: major.minor.patch[-preview.suffix]
+# - Versioning managed by GitVersion
+# - Preview suffix toggled by "preview" input
+# - Non-preview versions on nuget.org restricted to main branch;
+#   runs targeting nuget.org from non-"main" branches will fail early.
+# - Default: patch increment unless "+semver:" message found
+#   or will use "next-version" if set in config
+# - Preview numbers auto-increment (e.g., preview.1 -> preview.2)
+# - Branches are only tagged with the version after deployments to nuget.org
+
 on:
+  push:
+    branches:
+      - main
+      - 'v*'
+      - fix-deployer
+
   workflow_dispatch:
     inputs:
       environment:
@@ -23,19 +39,67 @@ on:
         required: true
 
 concurrency:
-  group: ${{ inputs.environment }}
+  group: ${{ github.ref_name }}
   cancel-in-progress: true
 
 jobs:
-  build:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Debug GitVersion config presence
+        run: cat src/gitversion.yml
+
+      - name: Setup GitVersion Tool
+        run: dotnet tool install --global GitVersion.Tool --version 6.0.5
+
+      - name: Show GitVersion config
+        run: dotnet gitversion -config src/gitversion.yml -showconfig
+
+      - name: Show GitVersion output
+        run: dotnet-gitversion -config src/gitversion.yml -updateassemblyinfo
+
+      - name: Validate preview settings
+        run: |
+          if [[ "${{ github.event.inputs.environment }}" == "nuget.org" ]] && \
+             [[ "${{ github.ref }}" != "refs/heads/main" ]] && \
+             [[ "${{ github.event.inputs.preview }}" != "true" ]]; then
+            echo "::error::Non-preview versions on nuget.org are only allowed from main branch"
+            exit 1
+          fi
+
+  package:
+    needs: validate
     runs-on: ubuntu-latest
+
     outputs:
       version: ${{ steps.version_info.outputs.version }}
-      pkg_url: ${{ steps.package_info.outputs.pkg_url }}
-      pkg_name: ${{ steps.package_info.outputs.pkg_name }}
+      url: ${{ steps.package_info.outputs.url }}
+      name: ${{ steps.package_info.outputs.name }}
+      environ: ${{ steps.settings.outputs.environ }}
+      preview: ${{ steps.settings.outputs.preview }}
+      dry_run: ${{ steps.settings.outputs.dry_run }}
 
     steps:
 
+      - name: Set default inputs for dispatch
+        id: settings
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            echo "environ=${{ inputs.environment }}" >> $GITHUB_OUTPUT
+            echo "preview=${{ inputs.preview }}" >> $GITHUB_OUTPUT
+            echo "dry_run=${{ inputs.dry_run }}" >> $GITHUB_OUTPUT
+          else
+            echo "environ=NO_ENVIRONMENT" >> $GITHUB_OUTPUT
+            echo "preview=true" >> $GITHUB_OUTPUT
+            echo "dry_run=true" >> $GITHUB_OUTPUT
+          fi
+
       - name: Checkout source
         uses: actions/checkout@v4
         with:
@@ -47,55 +111,44 @@ jobs:
           dotnet-version: "9.x"
           dotnet-quality: "ga"
 
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: "9.x"
-          dotnet-quality: "ga"
-
-      - name: Setup GitVersion
-        uses: gittools/actions/gitversion/[email protected]
-        with:
-          versionSpec: "5.x"
-          preferLatestVersion: true
-
       - name: Install dependencies
-        run: sudo apt-get update && sudo apt-get install -y libxml2-utils
+        run: |
+          sudo apt-get update && sudo apt-get install -y libxml2-utils
+          dotnet tool install --global GitVersion.Tool --version 6.0.5
 
-      - name: Determine version
+      - name: Show GitVersion config
+        run: dotnet-gitversion -config src/gitversion.yml -showconfig
+
+      - name: Generate version info
         id: gitversion
-        uses: gittools/actions/gitversion/[email protected]
-        with:
-          updateAssemblyInfo: true
-          useConfigFile: true
-          configFilePath: src/gitversion.yml
+        run: dotnet-gitversion -config src/gitversion.yml -updateassemblyinfo
 
       - name: Compose version
         id: version_info
         run: |
-          # get base version
-          base="${{ steps.gitversion.outputs.majorMinorPatch }}"
-
-          # determine preview suffix
-          preview_tag="${{ inputs.preview && '-preview.' || '' }}"
-
-          # determine preview number
-          preview_num="${{ inputs.preview && steps.gitversion.outputs.preReleaseNumber || '' }}"
+          # base version
+          base="${{ steps.gitversion.outputs.MajorMinorPatch }}"
 
-          # combine all parts
-          ver="${base}${preview_tag}${preview_num}"
+          # conditional suffix
+          if [[ "${{ steps.settings.outputs.preview }}" == "true" ]]; then
+            suffix="${{ steps.gitversion.outputs.PreReleaseTagWithDash }}"
+          else
+            suffix=""
+          fi
 
-          echo "version=$ver" >> "$GITHUB_OUTPUT"
+          ver="${base}${suffix}"
+          echo "version=$ver" >> $GITHUB_OUTPUT
+          echo "$ver"
 
       - name: Compose package info
         id: package_info
         run: |
           PACKAGE_NAME=$(xmllint --xpath "//PropertyGroup/PackageId/text()" src/Indicators.csproj)
-          echo "pkg_name=${PACKAGE_NAME}" >> $GITHUB_OUTPUT
-          if [[ "${{ inputs.environment }}" == "nuget.org" ]]; then
-            echo "pkg_url=https://www.nuget.org/packages/${PACKAGE_NAME}/${{ steps.version_info.outputs.version }}" >> $GITHUB_OUTPUT
+          echo "name=${PACKAGE_NAME}" >> $GITHUB_OUTPUT
+          if [[ "${{ steps.settings.outputs.environ }}" == "nuget.org" ]]; then
+            echo "url=https://www.nuget.org/packages/${PACKAGE_NAME}/${{ steps.version_info.outputs.version }}" >> $GITHUB_OUTPUT
           else
-            echo "pkg_url=https://github.com/${{ github.repository }}/packages/nuget/${PACKAGE_NAME}/${{ steps.version_info.outputs.version }}" >> $GITHUB_OUTPUT
+            echo "url=https://github.com/${{ github.repository }}/packages/nuget/${PACKAGE_NAME}/${{ steps.version_info.outputs.version }}" >> $GITHUB_OUTPUT
           fi
 
       - name: Build library
@@ -123,19 +176,25 @@ jobs:
           include-hidden-files: true
 
       - name: Summary output
+        if: always()
         run: |
           {
-            echo "| Version No. | Component                                       |"
-            echo "| :---------- | :---------------------------------------------- |"
-            echo "| Major       | ${{ steps.gitversion.outputs.major }}           |"
-            echo "| Minor       | ${{ steps.gitversion.outputs.minor }}           |"
-            echo "| Patch       | ${{ steps.gitversion.outputs.patch }}           |"
-            echo "| Base        | ${{ steps.gitversion.outputs.majorMinorPatch }} |"
-            echo "| Composed    | ${{ steps.version_info.outputs.version }}       |"
+            echo "| Version No.       | Component                                        |"
+            echo "| :---------------- | :----------------------------------------------- |"
+            echo "| Mode              | ${{ steps.settings.outputs.dry_run && '🔍 DRY RUN' || '🚀 DEPLOY' }} |"
+            echo "| Status            | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |"
+            echo "| Environment.      | ${{ steps.settings.outputs.environ }} |"
+            echo "| Preview           | ${{ steps.settings.outputs.preview && '✓' || '✗' }} |"
+            echo "| Base version      | ${{ steps.gitversion.outputs.MajorMinorPatch }}  |"
+            echo "| PreReleaseTag     | ${{ steps.gitversion.outputs.PreReleaseTag }}    |"
+            echo "| PreReleaseNumber  | ${{ steps.gitversion.outputs.PreReleaseNumber }} |"
+            echo "| Composed          | ${{ steps.version_info.outputs.version }}        |"
+            echo "| Package           | ${{ steps.package_info.outputs.name }}           |"
+            echo "| Package URL       | ${{ steps.package_info.outputs.url }}            |"
           } >> $GITHUB_STEP_SUMMARY
 
   deploy:
-    needs: build
+    needs: package
     runs-on: ubuntu-latest
     if: success()
 
@@ -144,8 +203,18 @@ jobs:
       packages: write
 
     environment:
-      name: ${{ !inputs.dry_run && inputs.environment || '' }}
-      url: ${{ needs.build.outputs.pkg_url }}
+      name: ${{ needs.package.outputs.environ }}
+      url: ${{ needs.package.outputs.url }}
+
+    env:
+      version: ${{ needs.package.outputs.version }}
+      preview: ${{ needs.package.outputs.preview }}
+      dry_run: ${{ needs.package.outputs.dry_run }}
+      environ: ${{ needs.package.outputs.environ }}
+      url: ${{ needs.package.outputs.url }}
+      name: ${{ needs.package.outputs.name }}
+      NUGET_PUBLISH_URL: ${{ needs.package.outputs.environ == 'nuget.org' && 'https://api.nuget.org/v3/index.json' || 'https://nuget.pkg.github.com/${{ github.repository }}/index.json' }}
+      NUGET_API_KEY: ${{ needs.package.outputs.environ == 'nuget.org' && secrets.NUGET_TOKEN || secrets.GITHUB_TOKEN }}
 
     steps:
 
@@ -155,47 +224,38 @@ jobs:
           dotnet-version: "9.x"
           dotnet-quality: "ga"
 
-      - name: Setup NuGet
-        uses: nuget/setup-nuget@v2
-        with:
-          nuget-api-key: ${{ secrets.NUGET_TOKEN }}
-          nuget-version: '6.x'
-
-
       - name: Download package
         uses: actions/download-artifact@v4
         with:
           name: packages
           path: NuGet
 
       - name: Publish package
-        if: ${{ !inputs.dry_run }}
-        env:
-          API_KEY: ${{ inputs.environment == 'nuget.org' && secrets.NUGET_TOKEN || secrets.GITHUB_TOKEN }}
+        if: ${{ !env.dry_run }}
         run: >
           dotnet nuget push NuGet/*.nupkg
-          --source "${{ vars.NUGET_PUBLISH_URL }}"
-          --api-key "$API_KEY"
+          --source "${{ env.NUGET_PUBLISH_URL }}"
+          --api-key "${{ env.NUGET_API_KEY }}"
           --skip-duplicate
 
       - name: Tag and draft release note
         uses: ncipollo/release-action@v1
-        if: ${{ !inputs.dry_run && inputs.environment == 'nuget.org' }}
+        if: ${{ !env.dry_run && env.environ == 'nuget.org' }}
         with:
           body: |
-            ## Release ${{ needs.build.outputs.version }}
+            ## Release ${{ env.version }}
 
-            📦 Package deployed to [${{ inputs.environment }}](${{ needs.build.outputs.pkg_url }})
+            📦 Package deployed to [${{ env.environ }}](${{ env.url }})
 
             ### Package Details
-            - **Name**: ${{ needs.build.outputs.pkg_name }}
-            - **Version**: ${{ needs.build.outputs.version }}
-            - **Preview**: ${{ inputs.preview && 'Yes' || 'No' }}
+            - **Name**: ${{ env.name }}
+            - **Version**: ${{ env.version }}
+            - **Preview**: ${{ env.preview && 'Yes' || 'No' }}
           generateReleaseNotes: true
           draft: true
-          makeLatest: ${{ !inputs.preview }}
-          prerelease: ${{ inputs.preview }}
-          tag: v${{ needs.build.outputs.version }}
+          makeLatest: ${{ !env.preview }}
+          prerelease: ${{ env.preview }}
+          tag: v${{ env.version }}
           commit: ${{ github.sha }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -206,10 +266,10 @@ jobs:
             echo "## Package Deployment"
             echo "| Parameter   | Value |"
             echo "|:------------|:------|"
-            echo "| Mode        | ${{ inputs.dry_run && '🔍 DRY RUN' || '🚀 DEPLOY' }} |"
+            echo "| Mode        | ${{ env.dry_run && '🔍 DRY RUN' || '🚀 DEPLOY' }} |"
             echo "| Status      | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |"
-            echo "| Environment | ${{ inputs.environment }} |"
-            echo "| Version     | ${{ needs.build.outputs.version }} |"
-            echo "| Package     | [${{ needs.build.outputs.pkg_name }}](${{ needs.build.outputs.pkg_url }}) |"
-            echo "| Preview     | ${{ inputs.preview && '✓' || '✗' }} |"
+            echo "| Environment | ${{ env.environ }} |"
+            echo "| Version     | ${{ env.version }} |"
+            echo "| Package     | [${{ env.name }}](${{ env.url }}) |"
+            echo "| Preview     | ${{ env.preview && '✓' || '✗' }} |"
           } >> $GITHUB_STEP_SUMMARY

.github/workflows/test-codeql.yml

@@ -5,7 +5,7 @@ on:
     branches: ["main"]
 
   pull_request:
-    branches: ["*"]
+    branches: ["main"]
 
   schedule:
     - cron: '37 14 * * 3'

.gitignore

@@ -332,3 +332,6 @@ _site/
 
 # zip artifacts
 .DS_Store
+
+# suppress dotnet tool manifest config (local) [for GitVersion]
+.config

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   // file settings
-  "files.autoSave": "off",
+  "files.autoSave": "afterDelay",
   "files.autoSaveDelay": 3000,
   "files.encoding": "utf8",
   "files.exclude": {

src/gitversion.yml

@@ -1,3 +1,5 @@
+# https://gitversion.net/docs/reference/configuration
+
 mode: ContinuousDelivery
 next-version: 3.0.0
 
@@ -8,7 +10,25 @@ patch-version-bump-message: '\+semver:\s?(fix|patch)'
 no-bump-message: '\+semver:\s?(none|skip)'
 
 branches:
-  pull-request:
-    tag: preview.
-  feature:
-    tag: preview.
+  main:
+    increment: Patch
+    source-branches: []
+    is-main-branch: true
+    label: preview
+
+  release:
+    regex: ^v[0-9]+\.*
+    increment: Patch
+    source-branches: [main]
+    label: preview
+
+  unknown:
+    increment: Inherit
+    label: preview
+
+label: preview
+
+ignore:
+  sha: []
+
+merge-message-formats: {}