WIP: Version 1.0.0

.github/actions/assemble-release/action.yml

@@ -14,7 +14,7 @@ inputs:
     default: "**/*.pdb"
 
   output-file-name:
-    description: Output artifact name used in the upload-artifact action. a zip file with this name will be created in the github workspace so that it can be immediately consumed by other actions in the workflow without having to download the artifact.
+    description: Output artifact name used in the upload-artifact action WITHOUT ".zip" extension. a zip file with this name will be created in the github workspace so that it can be immediately consumed by other actions in the workflow without having to download the artifact.
     default: ${{ github.event.repository.name || 'release'}}
 
   working-directory:
@@ -61,7 +61,7 @@ runs:
       run: |
         zip -r ${{ github.workspace }}/${{ inputs.output-file-name }}.zip .
         echo 'ARTIFACT_FILENAME=${{ inputs.output-file-name }}' >> $GITHUB_ENV
-        echo 'artifact-path=${{ github.workspace }}/${{ inputs.output-file-name }}' >> $GITHUB_OUTPUT
+        echo 'artifact-path=${{ github.workspace }}/${{ inputs.output-file-name }}.zip' >> $GITHUB_OUTPUT
 
     - name: Upload Artifact
       id: upload-artifact

.github/actions/compile/action.yml

@@ -10,10 +10,6 @@ inputs:
     default: Release
     description: The project configuration to build.
 
-  dotnet-version:
-    default: 5.x
-    description: Version of dotnet compiler to use.  Defaults to 5.x.
-
   ksp-zip-url:
     default: https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip
     description: >
@@ -36,6 +32,12 @@ inputs:
     default: ${{ github.workspace }}
     description: the working directory to run in
 
+  use-nuget-restore:
+    default: 'false'
+    description: > 
+      Set to true if your project uses a packages.config file instead of packagereferences. Ensure the environment has 
+      nuget and mono installed, either installing them manually or by using the Github Ubuntu-22.04 images
+
 runs:
   using: composite
   steps:
@@ -55,11 +57,6 @@ runs:
       shell: bash
       run: echo 'KSP_ROOT=${{ '/tmp/ksp' }}' >> "$GITHUB_ENV"
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: ${{ inputs.dotnet-version }}
-
     - name: Download KSP Libs
       shell: bash
       run: |
@@ -68,13 +65,20 @@ runs:
 
     - name: Restore Mod Solution
       shell: bash
+      if: ${{ inputs.use-nuget-restore != 'true'}} # https://github.com/actions/runner/issues/1483 :sufferbeale:
+      working-directory: ${{ inputs.working-directory }}
+      run: dotnet restore ${{ inputs.solution-file-path }} ${{ runner.debug && '-v:diagnostic' }}
+
+    - name: Restore Mod Solution (NuGet)
+      shell: bash
+      if: ${{ inputs.use-nuget-restore  == 'true'}}
       working-directory: ${{ inputs.working-directory }}
       run: nuget restore ${{ inputs.solution-file-path }} -Verbosity detailed
 
     - name: Build Mod Solution
       shell: bash
       working-directory: ${{ inputs.working-directory }}
-      run: |
-        dotnet msbuild -m:1 -p:Configuration=${{ inputs.build-configuration }} \
-        -p:ManagedRelativePath=KSP_x64_Data/Managed ${{ inputs.solution-file-path }} \
-        ${{ runner.debug && '-v:detailed' }}
+      run: >
+        dotnet msbuild -m:1 -p:Configuration=${{ inputs.build-configuration }}
+        -p:KSPBT_ManagedPath=${{ env.KSP_ROOT }}/KSP_x64_Data/Managed ${{ inputs.solution-file-path }}
+        ${{ runner.debug && '-v:diagnostic' }}

.github/actions/setup-ckan/action.yml

@@ -6,6 +6,10 @@ x-env:
     description: The path to use as the root of a KSP instance for CKAN to set-up. If not set, `/tmp/ksp` is used instead.
 
 inputs:
+  ckan-install-method:
+    description: Method of installing CKAN. Can be set to 'apt' to install from the official .deb file, or 'skip' to skip installation if your runner already has CKAN installed.
+    default: 'apt'
+
   ckan-version:
     description: CKAN tag to install. set to an empty string to always install the most recent version. See [the CKAN releases page](https://github.com/KSP-CKAN/CKAN/tags) for a list of available tags
     default: ''
@@ -42,24 +46,26 @@ runs:
       shell: bash
       run: echo 'KSP_ROOT=${{ '/tmp/ksp' }}' >> "$GITHUB_ENV"
 
-    - name: Install CKAN
+    - name: Install CKAN via apt
+      if: ${{ inputs.ckan-install-method == 'apt' }}
       shell: bash
       run: |
+        sudo rm -f /var/lib/man-db/auto-update # skip updating man pages, which takes a long time and makes no sense in a CI job
         gh release download ${{ inputs.ckan-version }} --repo ${{ inputs.ckan-repo }} --pattern 'ckan*.deb' -O ckan.deb
         ${{ env.ACT && 'sudo apt update --quiet' }}
-        sudo apt install --quiet ./ckan.deb  ${{ runner.debug && '--verbose-versions' }}
+        sudo apt install --quiet --no-install-recommends --no-install-suggests ./ckan.deb  ${{ runner.debug && '--verbose-versions' }}
         ckan version
       env:
         GH_TOKEN: ${{ github.token }}
 
-    - name: Setup CKAN Instance
+    - name: Setup fake KSP instance
       shell: bash
       run: |
         ${{ runner.debug && 'echo "$PATH"' }}
         ckan instance fake --set-default KSP ${{ env.KSP_ROOT }} 1.12.5 --game KSP --MakingHistory 1.9.1 --BreakingGround 1.7.1  ${{ runner.debug && '--verbose' }}
         ckan update
 
-    - name: Setup CKAN Compatible Versions
+    - name: Setup CKAN compatible versions
       shell: bash
       if: inputs.ckan-compatible-versions != ''
       run: |
@@ -69,7 +75,7 @@ runs:
       env:
         VERSIONS: ${{ inputs.ckan-compatible-versions }}
 
-    - name: Setup CKAN Filter
+    - name: Setup CKAN filter
       shell: bash
       if: inputs.ckan-filters != ''
       run: |

.github/workflows/build.yml

@@ -22,6 +22,16 @@ on:
         description: >
           If MSBuild should be used. If your mod has no msbuild project (e.g. a pure part mod) 
           you should set this to false
+      use-nuget-restore:
+        type: boolean
+        default: false
+        description: >
+          Set to true if your project uses a packages.config file instead of packagereferences. This will cause the job 
+          to run on the Ubuntu-22.04 image instead of Ubuntu-24.04
+      dotnet-version:
+        type: string
+        default: 8.x
+        description: Version of dotnet compiler to use.
       use-ckan:
         type: boolean
         default: false
@@ -37,34 +47,40 @@ defaults:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ${{ inputs.use-nuget-restore && 'ubuntu-22.04' || 'ubuntu-24.04' }}
     steps:
       - name: Checkout Mod Repo
         uses: actions/checkout@v4
         with:
           submodules: true
 
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: ${{ inputs.dotnet-version }}
+
       # Install CKAN and set up an instance
-      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/setup-ckan@1.0.0-alpha.3
         if: ${{ (inputs.use-ckan && inputs.use-msbuild) || inputs.dependency-identifiers }}
 
       # Install any listed CKAN dependencies
-      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/install-dependencies@1.0.0-alpha.3
         if: ${{ inputs.dependency-identifiers }}
         with:
           dependency-identifiers: ${{ inputs.dependency-identifiers }}
 
       # Compile the mod
-      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/compile@1.0.0-alpha.3
         if: ${{ inputs.use-msbuild }}
         with:
           build-configuration: ${{ inputs.build-configuration }}
           ksp-zip-url: ${{ inputs.ksp-zip-url }}
           ksp-zip-password: ${{ secrets.ksp-zip-password }}
           solution-file-path: ${{ inputs.solution-file-path }}
+          use-nuget-restore: ${{ inputs.use-nuget-restore }}
 
       # Assemble the mod into a release package and upload it as an artifact
-      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/assemble-release@1.0.0-alpha.3
         with:
           artifacts: ${{ inputs.artifacts }}
           output-file-name: ${{ github.event.repository.name }}-${{ inputs.build-configuration }}

.github/workflows/create-release.yml

@@ -64,7 +64,7 @@ jobs:
           submodules: true
 
       - name: update-version
-        uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+        uses: KSPModdingLibs/KSPBuildTools/.github/actions/update-version@1.0.0-alpha.3
         with:
           version-string: ${{ inputs.version-string }}
           template-extension: ${{ inputs.version-template-extension }}
@@ -81,18 +81,18 @@ jobs:
           git tag -f -a "$VERSION_STRING" -m "$VERSION_STRING"
 
       # Install CKAN and set up an instance
-      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/setup-ckan@1.0.0-alpha.3
         if: ${{ (inputs.use-ckan && inputs.use-msbuild) || inputs.dependency-identifiers }}
 
       # Install any listed CKAN dependencies
-      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/install-dependencies@1.0.0-alpha.3
         if: ${{ inputs.dependency-identifiers }}
         with:
           dependency-identifiers: ${{ inputs.dependency-identifiers }}
 
       - name: compile
         if: ${{ inputs.use-msbuild }}
-        uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+        uses: KSPModdingLibs/KSPBuildTools/.github/actions/compile@1.0.0-alpha.3
         with:
           build-configuration: ${{ inputs.build-configuration }}
           ksp-zip-url: ${{ inputs.ksp-zip-url }}
@@ -101,7 +101,7 @@ jobs:
 
       - name: assemble-release
         id: assemble-release
-        uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+        uses: KSPModdingLibs/KSPBuildTools/.github/actions/assemble-release@1.0.0-alpha.3
         with:
           artifacts: ${{ inputs.artifacts }}
           output-file-name: ${{ github.event.repository.name }}-${{ env.VERSION_STRING }}

.github/workflows/internal-ci.yml

@@ -19,7 +19,7 @@ jobs:
     env:
       DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
       DOTNET_NOLOGO: true
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     outputs:
       package-version: ${{ steps.get-version.outputs.version }}
     steps:

.github/workflows/internal-test-assetbundle.yml

@@ -12,7 +12,7 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 

.github/workflows/internal-test-plugin-legacy.yml

@@ -12,13 +12,19 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.x'
 
       - uses: ./.github/actions/setup-ckan
 
       - uses: ./.github/actions/compile
         with:
           ksp-zip-url: https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip
           working-directory: ${{ env.TESTDIR }}
+          use-nuget-restore: true
 
       - uses: ./.github/actions/assemble-release
         with:

.github/workflows/internal-test-plugin-nuget.yml

@@ -13,20 +13,24 @@ env:
   NuGetDirectory: ${{ github.workspace}}/nuget
 
 jobs:
+
   build:
-    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        dotnet-version: [ 7.x, 8.x, 9.x ]
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: 8.0.x
+          dotnet-version: ${{ matrix.dotnet-version }}
 
       - name: Setup Nuget Package Sources
         run: |
           mkdir -p ${{ env.NuGetDirectory }}/local
-          nuget sources add -Name local -Source ${{ env.NuGetDirectory }}/local
+          dotnet nuget add source ${{ env.NuGetDirectory }}/local -n local
 
       - uses: actions/download-artifact@v4
         with:
@@ -39,11 +43,11 @@ jobs:
         with:
           ksp-zip-url: https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip
           working-directory: ${{ env.TESTDIR }}
-          solution-file-path: plugin-mod.csproj
+          solution-file-path: plugin-mod-nuget.csproj
         env:
           KSPBuildToolsVersion: ${{ inputs.package-version }}
 
       - uses: ./.github/actions/assemble-release
         with:
           artifacts: ${{ env.TESTDIR }}/GameData
-          output-file-name: plugin-mod-nuget
+          output-file-name: plugin-mod-nuget-${{ matrix.dotnet-version }}

.github/workflows/internal-test-plugin.yml

@@ -9,9 +9,14 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.x'
 
       - uses: ./.github/actions/setup-ckan
 

.github/workflows/publish-to-spacedock.yml

@@ -27,11 +27,11 @@ on:
 
 jobs:
   publish-to-spacedock:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: get-release-info
         id: get-release-info
-        uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected].5
+        uses: KSPModdingLibs/KSPBuildTools/.github/actions/get-release-info@1.0.0-alpha.3
         with:
           release-tag: ${{ inputs.release-tag }}
 

.github/workflows/validate.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   validate:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4

.gitignore

@@ -2,6 +2,7 @@
 bin
 obj
 *.nupkg
+packages
 
 # docs
 docs/_build

CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file
 
+## 1.0.0-alpha.3 - 2025-11-14
+
+### Msbuild
+
+- Renamed global msbuild properties to have the `KSPBT_` prefix to avoid namespace collisions with other frameworks
+  - `KSPRoot` is now `KSPBT_GameRoot`. It should no longer be referenced within a .csproj file
+  - `RepoRootPath` is now `KSPBT_ModRoot`, and should now point to the mod folder within GameData rather than the
+    root of a git repo
+  - `BinariesOutputRelativePath` is now `KSPBT_ModPluginFolder`
+  - `GenerateKSPAssemblyAttribute` is now `KSPBT_GenerateAssemblyAttribute` and defaults to true
+  - `GenerateKSPAssemblyDependencyAttributes` is now `KSPBT_GenerateDependencyAttributes` and defaults to true
+  - `ReferenceUnityAssemblies` is now `KSPBT_ReferenceUnityAssemblies`
+  - `ReferenceKSPAssemblies` is now `KSPBT_ReferenceGameAssemblies`
+- Added the `KSPBT_ReferenceSystemAssemblies` property to control referencing the mono system DLLs within the KSP
+  managed folder. Setting this property to false will load the implicit framework DLLs instead.
+- Mod dependencies should now be declared with
+  `ModReference` items. This avoids the need for the KSP install path to be known at evaluation time.
+- Only include Log.cs (or anything else in include/unity) when `KSPBT_ReferenceUnityAssemblies` is `true` (#61)
+- Fix `KSP_VERSION_MAX` getting mangled when using an existing version file (#64)
+- Fix incorrect behavior when building without a solution (#50)
+
+### Actions
+
+- KSPBT actions used in reusable workflows are now pinned with each tag, instead of using actions from `main`. All calls to reusable workflows should be pinned to a tag to ensure the correct actions are being used. (#21)
+- `compile` action: Use `dotnet restore` instead of `nuget restore` by default, allowing the action to work on any Ubuntu runner image. Added the `use-nuget-restore` option to restore the previous behavior for projects that use packages.config for dependencies. (#68)
+- `compile` action: Removed call to`actions/setup-dotnet`. Setting up .NET should be done as a separate step. (#65)
+- `setup-ckan` action: Sped up execution by skipping recommended packages and man-db updates
+- `setup-ckan` action: Add `ckan-install-method` option for installation method. Currently supports `'apt'` for installation on Debian/Ubuntu, or `'skip'` to skip installation for runners that already have CKAN installed.
+- `assemble-release` action: `outputs.artifact-path` now includes the `.zip` extension (#51)
+
+
 ## 0.0.5 - 2025-11-07
 
 Several non-breaking bugfixes backported from the next development version