feat: improve version stamping (#389)

2025-12-05 23:58:24 -08:00 · 2024-03-25 17:11:16 +10:00
parent 9d8b6beae6
commit 5c67d88844
7 changed files with 147 additions and 93 deletions
--- a/.github/workflows/cmake-single-platform.yml
+++ b/.github/workflows/cmake-single-platform.yml
@@ -3,22 +3,42 @@ name: Build & Publish
 on:
  push:
    paths-ignore:
-      - 'docfx/**'
-    branches: [ "main", "dev" ]
+      - "docfx/**"
+    branches: ["main", "dev"]
  pull_request:
-    branches: [ "main", "dev" ]
+    branches: ["main", "dev"]

 env:
  BUILD_TYPE: Release

 jobs:
+  setup:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    outputs:
+      buildnumber: ${{ steps.buildnumber.outputs.build_number }}
+    steps:
+      - name: Generate build number
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        id: buildnumber
+        uses: onyxmueller/build-tag-number@v1
+        with:
+          token: ${{secrets.github_token}}
+
  build_windows:
+    needs: setup
    runs-on: windows-latest
    steps:
      - name: Prepare env
        shell: bash
        run: echo "GITHUB_SHA_SHORT=${GITHUB_SHA::7}" >> $GITHUB_ENV

+      - name: Fallback build number
+        if: ${{ github.event_name == 'pull_request' || github.ref != 'refs/heads/main' }}
+        shell: bash
+        run: echo "BUILD_NUMBER=0" >> $GITHUB_ENV
+
      - name: Visual Studio environment
        shell: cmd
        run: |
@@ -34,7 +54,7 @@ jobs:

      - uses: actions/checkout@v3
        with:
-          submodules: 'recursive'
+          submodules: "recursive"

      - name: Build
        run: |
@@ -56,6 +76,7 @@ jobs:
          path: build/output/

  build_linux:
+    needs: setup
    runs-on: ubuntu-latest
    # Could not figure out how to run in a container only on some matrix paths, so I've split it out into its own build.
    container:
@@ -65,9 +86,14 @@ jobs:
        shell: bash
        run: echo "GITHUB_SHA_SHORT=${GITHUB_SHA::7}" >> $GITHUB_ENV

+      - name: Fallback build number
+        if: ${{ github.event_name == 'pull_request' || github.ref != 'refs/heads/main' }}
+        shell: bash
+        run: echo "BUILD_NUMBER=0" >> $GITHUB_ENV
+
      - uses: actions/checkout@v3
        with:
-          submodules: 'recursive'
+          submodules: "recursive"

      - name: Build
        run: |
@@ -87,11 +113,10 @@ jobs:
          path: build/output/

  build_managed:
+    needs: setup
    permissions:
      contents: write
    runs-on: ubuntu-latest
-    outputs:
-      buildnumber: ${{ steps.buildnumber.outputs.build_number }}
    steps:
      - name: Prepare env
        shell: bash
@@ -105,13 +130,6 @@ jobs:
      # We don't need expensive submodules for the managed side.
      - uses: actions/checkout@v3

-      - name: Generate build number
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-        id: buildnumber
-        uses: onyxmueller/build-tag-number@v1
-        with:
-          token: ${{secrets.github_token}}
-
      - name: Build runtime v${{ env.BUILD_NUMBER }}
        uses: actions/setup-dotnet@v3
        with:
@@ -144,7 +162,7 @@ jobs:
    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
    permissions:
      contents: write
-    needs: [ "build_linux", "build_windows", "build_managed" ]
+    needs: ["setup", "build_linux", "build_windows", "build_managed"]
    runs-on: ubuntu-latest
    steps:
      - name: Prepare env
@@ -176,8 +194,8 @@ jobs:

      - name: Zip Builds
        run: |
-          (cd build/linux && zip -qq -r ../../counterstrikesharp-build-${{ needs.build_managed.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip *)
-          (cd build/windows && zip -qq -r ../../counterstrikesharp-build-${{ needs.build_managed.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip *)
+          (cd build/linux && zip -qq -r ../../counterstrikesharp-build-${{ needs.setup.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip *)
+          (cd build/windows && zip -qq -r ../../counterstrikesharp-build-${{ needs.setup.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip *)

      - name: Add dotnet runtime
        run: |
@@ -191,28 +209,28 @@ jobs:

      - name: Zip Builds
        run: |
-          (cd build/linux && zip -qq -r ../../counterstrikesharp-with-runtime-build-${{ needs.build_managed.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip *)
-          (cd build/windows && zip -qq -r ../../counterstrikesharp-with-runtime-build-${{ needs.build_managed.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip *)
+          (cd build/linux && zip -qq -r ../../counterstrikesharp-with-runtime-build-${{ needs.setup.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip *)
+          (cd build/windows && zip -qq -r ../../counterstrikesharp-with-runtime-build-${{ needs.setup.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip *)

      - name: Release
        id: release
        uses: softprops/action-gh-release@v1
        with:
-          tag_name: v${{ needs.build_managed.outputs.buildnumber }}
+          tag_name: v${{ needs.setup.outputs.buildnumber }}
          files: |
-            counterstrikesharp-build-${{ needs.build_managed.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip
-            counterstrikesharp-with-runtime-build-${{ needs.build_managed.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip
-            counterstrikesharp-build-${{ needs.build_managed.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip
-            counterstrikesharp-with-runtime-build-${{ needs.build_managed.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip
+            counterstrikesharp-build-${{ needs.setup.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip
+            counterstrikesharp-with-runtime-build-${{ needs.setup.outputs.buildnumber }}-windows-${{ env.GITHUB_SHA_SHORT }}.zip
+            counterstrikesharp-build-${{ needs.setup.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip
+            counterstrikesharp-with-runtime-build-${{ needs.setup.outputs.buildnumber }}-linux-${{ env.GITHUB_SHA_SHORT }}.zip

      - name: Publish NuGet package
        run: |
-          dotnet nuget push build/api/CounterStrikeSharp.API.1.0.${{ needs.build_managed.outputs.buildnumber }}.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
-          dotnet nuget push build/api/CounterStrikeSharp.API.1.0.${{ needs.build_managed.outputs.buildnumber }}.snupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
+          dotnet nuget push build/api/CounterStrikeSharp.API.1.0.${{ needs.setup.outputs.buildnumber }}.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
+          dotnet nuget push build/api/CounterStrikeSharp.API.1.0.${{ needs.setup.outputs.buildnumber }}.snupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate

      - name: Send Notification to Discord
        env:
          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
        uses: Ilshidur/action-discord@0.3.2
        with:
-          args: "A new release of CS# has been tagged (v${{ needs.build_managed.outputs.buildnumber }}) at ${{ steps.release.outputs.url }}"
+          args: "A new release of CS# has been tagged (v${{ needs.setup.outputs.buildnumber }}) at ${{ steps.release.outputs.url }}"
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
 .ccls-cache/
 .cmake/
-cmake-build-debug*/
+cmake-build-*/
 .kdev4/
 .vscode/
 generated/
--- a/makefiles/shared.cmake
+++ b/makefiles/shared.cmake
@@ -29,6 +29,18 @@ set(SOURCESDK_LIB ${SOURCESDK}/lib)

 add_definitions(-DMETA_IS_SOURCE2)

+if(DEFINED ENV{GITHUB_SHA_SHORT})
+    add_definitions(-DGITHUB_SHA="$ENV{GITHUB_SHA_SHORT}")
+else()
+    add_definitions(-DGITHUB_SHA="Local")
+endif()
+
+if(DEFINED ENV{BUILD_NUMBER})
+    add_definitions(-DBUILD_NUMBER="$ENV{BUILD_NUMBER}")
+else()
+    add_definitions(-DBUILD_NUMBER="0")
+endif()
+
 include_directories(
    ${SOURCESDK}
    ${SOURCESDK}/thirdparty/protobuf-3.21.8/src
--- a/managed/CounterStrikeSharp.API/Api.cs
+++ b/managed/CounterStrikeSharp.API/Api.cs
@@ -13,4 +13,14 @@ public class Api
    {
        return Assembly.GetAssembly(typeof(BasePlugin))!.GetName().Version!.Build;
    }
+    
+    /// <summary>
+    /// Returns the assembly version of CounterStrikeSharp running on the server as a string including git commit hash
+    /// </summary>
+    /// <example>1.0.0+9d8b6be</example>
+    public static string GetVersionString()
+    {
+        return Assembly.GetAssembly(typeof(BasePlugin))!.GetCustomAttribute<AssemblyInformationalVersionAttribute>()!
+            .InformationalVersion;
+    }
 }
--- a/managed/CounterStrikeSharp.API/Core/Application.cs
+++ b/managed/CounterStrikeSharp.API/Core/Application.cs
@@ -106,13 +106,13 @@ namespace CounterStrikeSharp.API.Core
        [RequiresPermissions("@css/generic")]
        private void OnCSSCommand(CCSPlayerController? caller, CommandInfo info)
        {
-            var currentVersion = Api.GetVersion();
+            var versionString = $"v{Api.GetVersion()} ({Api.GetVersionString()})";

            info.ReplyToCommand(
                "  CounterStrikeSharp was created and is maintained by Michael \"roflmuffin\" Wilson.\n" +
                "  Counter-Strike Sharp uses code borrowed from SourceMod, Source.Python, FiveM, Saul Rennison, source2gen and CS2Fixes.\n" +
                "  See ACKNOWLEDGEMENTS.md for more information.\n" +
-                "  Current API Version: " + currentVersion);
+                "  Current API Version: " + versionString);
            return;
        }

--- a/managed/CounterStrikeSharp.API/CounterStrikeSharp.API.csproj
+++ b/managed/CounterStrikeSharp.API/CounterStrikeSharp.API.csproj
@@ -1,63 +1,74 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup>
-    <TargetFramework>net8.0</TargetFramework>
-    <EnableDynamicLoading>true</EnableDynamicLoading>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <GenerateCompatibilitySuppressionFile>true</GenerateCompatibilitySuppressionFile>
-    <EnablePackageValidation>true</EnablePackageValidation>
-    <NoWarn>$(NoWarn);CS1591;CP0003</NoWarn>
-    <Nullable>enable</Nullable>
-	<GenerateCompatibilitySuppressionFile>true</GenerateCompatibilitySuppressionFile>
-    <Authors>Roflmuffin</Authors>
-    <Description>Official server side runtime assembly for CounterStrikeSharp</Description>
-    <PackageProjectUrl>http://docs.cssharp.dev/</PackageProjectUrl>
-    <RepositoryUrl>https://github.com/roflmuffin/CounterStrikeSharp</RepositoryUrl>
-    <PackageLicenseExpression>GPL-3.0-only</PackageLicenseExpression>
-    <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <IncludeSymbols>true</IncludeSymbols>
-    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-    <!-- <GenerateCompatibilitySuppressionFile>true</GenerateCompatibilitySuppressionFile> -->
-  </PropertyGroup>
-  <PropertyGroup>
-    <ApiCompatValidateAssemblies>true</ApiCompatValidateAssemblies>
-    <ApiCompatContractAssembly>.\ApiCompat\v151.dll</ApiCompatContractAssembly>
-  </PropertyGroup>
-  <ItemGroup>
-    <None Remove="Modules\Commands\CommandInfo" />
-    <None Remove="Modules\Disabled\**" />
-  </ItemGroup>
-  <ItemGroup>
-    <PackageReference Include="McMaster.NETCore.Plugins" Version="1.4.0" />
-    <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
-    <PackageReference Include="Microsoft.DotNet.ApiCompat.Task" Version="7.0.404" />
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="7.0.3" />
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
-    <PackageReference Include="Scrutor" Version="4.2.2" />
-    <PackageReference Include="Serilog.Extensions.Logging" Version="7.0.0" />
-    <PackageReference Include="Serilog.Sinks.Console" Version="5.0.0" />
-    <PackageReference Include="Serilog.Sinks.File" Version="5.0.0" />
-    <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
-  </ItemGroup>
-  <ItemGroup>
-    <Folder Include="Core\Schema\" />
-    <Folder Include="Modules\Errors" />
-  </ItemGroup>
-  <ItemGroup>
-    <Compile Remove="Modules\Disabled\**" />
-  </ItemGroup>
-  <ItemGroup>
-    <EmbeddedResource Remove="Modules\Disabled\**" />
-  </ItemGroup>
-  <PropertyGroup />
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
-    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
-    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
-  </PropertyGroup>
-<!--  <Target Name="PreBuild" BeforeTargets="PreBuildEvent">-->
-<!--    <Exec Command="dotnet run &#45;&#45;project ../../tooling/CodeGen.Natives" />-->
-<!--  </Target>-->
+    <PropertyGroup>
+        <TargetFramework>net8.0</TargetFramework>
+        <EnableDynamicLoading>true</EnableDynamicLoading>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <GenerateCompatibilitySuppressionFile>true</GenerateCompatibilitySuppressionFile>
+        <EnablePackageValidation>true</EnablePackageValidation>
+        <NoWarn>$(NoWarn);CS1591;CP0003</NoWarn>
+        <Nullable>enable</Nullable>
+        <GenerateCompatibilitySuppressionFile>true</GenerateCompatibilitySuppressionFile>
+        <Authors>Roflmuffin</Authors>
+        <Description>Official server side runtime assembly for CounterStrikeSharp</Description>
+        <PackageProjectUrl>http://docs.cssharp.dev/</PackageProjectUrl>
+        <RepositoryUrl>https://github.com/roflmuffin/CounterStrikeSharp</RepositoryUrl>
+        <PackageLicenseExpression>GPL-3.0-only</PackageLicenseExpression>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <IncludeSymbols>true</IncludeSymbols>
+        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+        <SourceControlInformationFeatureSupported>true</SourceControlInformationFeatureSupported>
+        <!-- <GenerateCompatibilitySuppressionFile>true</GenerateCompatibilitySuppressionFile> -->
+    </PropertyGroup>
+    <PropertyGroup>
+        <ApiCompatValidateAssemblies>true</ApiCompatValidateAssemblies>
+        <ApiCompatContractAssembly>.\ApiCompat\v151.dll</ApiCompatContractAssembly>
+    </PropertyGroup>
+    <ItemGroup>
+        <None Remove="Modules\Commands\CommandInfo"/>
+        <None Remove="Modules\Disabled\**"/>
+    </ItemGroup>
+    <ItemGroup>
+        <PackageReference Include="McMaster.NETCore.Plugins" Version="1.4.0"/>
+        <PackageReference Include="Microsoft.CSharp" Version="4.7.0"/>
+        <PackageReference Include="Microsoft.DotNet.ApiCompat.Task" Version="8.0.203"/>
+        <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0"/>
+        <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.0"/>
+        <PackageReference Include="Microsoft.Extensions.Localization.Abstractions" Version="8.0.3"/>
+        <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0"/>
+        <PackageReference Include="Scrutor" Version="4.2.2"/>
+        <PackageReference Include="Serilog.Extensions.Logging" Version="8.0.0"/>
+        <PackageReference Include="Serilog.Sinks.Console" Version="5.0.0"/>
+        <PackageReference Include="Serilog.Sinks.File" Version="5.0.0"/>
+        <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0"/>
+    </ItemGroup>
+    <ItemGroup>
+        <Folder Include="Core\Schema\"/>
+        <Folder Include="Modules\Errors"/>
+    </ItemGroup>
+    <ItemGroup>
+        <Compile Remove="Modules\Disabled\**"/>
+    </ItemGroup>
+    <ItemGroup>
+        <EmbeddedResource Remove="Modules\Disabled\**"/>
+    </ItemGroup>
+    <PropertyGroup/>
+    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+        <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    </PropertyGroup>
+    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+        <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    </PropertyGroup>
+    <Target Name="SetSourceRevisionId" BeforeTargets="InitializeSourceControlInformation">
+        <Exec
+                Command="git describe --long --always --exclude=* --abbrev=7"
+                ConsoleToMSBuild="True"
+                IgnoreExitCode="False"
+        >
+            <Output PropertyName="SourceRevisionId" TaskParameter="ConsoleOutput"/>
+        </Exec>
+    </Target>
+
+    <!--  <Target Name="PreBuild" BeforeTargets="PreBuildEvent">-->
+    <!--    <Exec Command="dotnet run &#45;&#45;project ../../tooling/CodeGen.Natives" />-->
+    <!--  </Target>-->
 </Project>
--- a/src/mm_plugin.cpp
+++ b/src/mm_plugin.cpp
@@ -33,6 +33,9 @@
 #include "entity2/entitysystem.h"
 #include "interfaces/cs2_interfaces.h"

+#define VERSION_STRING "v" BUILD_NUMBER " @ " GITHUB_SHA
+#define BUILD_TIMESTAMP __DATE__ " " __TIME__
+
 counterstrikesharp::GlobalClass* counterstrikesharp::GlobalClass::head = nullptr;

 CGameEntitySystem *GameEntitySystem()
@@ -265,9 +268,9 @@ bool CounterStrikeSharpMMPlugin::Unpause(char* error, size_t maxlen) { return tr

 const char* CounterStrikeSharpMMPlugin::GetLicense() { return "GNU GPLv3"; }

-const char* CounterStrikeSharpMMPlugin::GetVersion() { return "0.1.0"; }
+const char* CounterStrikeSharpMMPlugin::GetVersion() { return VERSION_STRING; }

-const char* CounterStrikeSharpMMPlugin::GetDate() { return __DATE__; }
+const char* CounterStrikeSharpMMPlugin::GetDate() { return BUILD_TIMESTAMP; }

 const char* CounterStrikeSharpMMPlugin::GetLogTag() { return "CSSHARP"; }