Refactor with assorted changes (#20)

* GetRequiredExternalTools target

Theres annoyingly no way to export environment variables from msbuild which sucks, so actually using this requires a few bonus flags.

Right prints an empty string if no CKAN dependencies are included, otherwise prints "CKAN". Allows extensibility for other tools, like possibly requiring the Unity editor

* kill KSP_ROOT

environment variables already get passed to msbuild, so the "-p" lines in msbuild calls are unnecessary if you just make the variable names the same

* action for installing dependencies now checks if CKAN is required

* Make some `uses` calls relative

just testing really

* Use workflows from the git submodule instead of github

ok heres the deal:
All the references to "@main" means that if the user wants to pin KSPBuildTools to a specific version or commit (perfectly reasonable if theres ever breaking changes), then any sub-action will still call from the main branch. Alternatively we can just use the file directly from the git submodule, which is needed anyways for KSPCommon.props. That way version pinning is done entirely through the git submodule to a specific commit

* slightly more portable msbuild calls

Some runners (other than the github one) don't bundle the standalone msbuild (part of VS??) but do include dotnet. afaict these two are identical in use.

* add compatible versions and filters to ckan-setup action

* actions: use KSPRoot instead of KSP_ROOT environment variable

* use the correct ref in nested actions

* Change of strategy

Instead of a couple big uber-configurable actions, have a handful of small ones. its still only 6 steps total in the template workflow.

* ckan-setup: install CKAN, setup an instance, install any mods listed
* install-dependencies: run the CKANInstall target in msbuild
* compile: Same as before, but no longer calls the previous 2 steps

all or none of these can be used by the user depending on what their mod is and how it is set-up

I think this will be a lot more modular and easy to use?

* fix typo

* Fix broken syntax in env nodes

* fix syntax redux

* yaml i s2g

* interpolation syntax is needed here

* turns out this was not actually more portable

fucking mono vs dotnet shit

* Install CKAN using cached apt packages for speed

* Revert "Install CKAN using cached apt packages for speed"

This reverts commit 4c85562.

* Can we just install ckan directly?

I mean, its just a mono exe... why bother with apt? as a bonus its cross platform!

* oops

* oops 2

* fix url

* make sure ckan directory exists

* fix dir name

* quick debug info

* bah

* maybe this works?

* actually download ckan to where its supposed to be

* I hate bash string interpolation

* use workspace instead of HOME

* fix second reference

* take the -L

* Fix slug generation 🐌

* don't require 'v' in ckan version

* fix pinned asset URLs

* Move ckan-setup to setup-ckan

For commonality with most other "setup" actions in the world

* Default KSPRoot to the "KSP_ROOT" environment variable if it exists

* Rework ckan dependency installation

Now faster by using `ckan prompt`, as well as running before the `Restore` target instead of on its own. Also remove the confusingly named `install-dependencies` action, which is what ran this target before.

* Fix broken temp directory path

* temp directory instead of file

* fix restore call and add debug info

* use `gh release` to download ckan instead of url hacks

allows using the deb instead of bare exe, thank god. also might be faster on github infra?

* yaml lol

* fix input reference

* why is this even necessary

* actually use the .deb

* Get working on local nektos-act runners

when running in nektos-act, use the custom-latest image and set the `act-local` variable to true

* fix var name

* Remove mod install step from setup-ckan

Probably too confusing. I don't think this needs to be replaced with anything, adding a `ckan install --headless` step in the mod-level workflow is fine?

* Documentation and cleanup pass

RELEASE_STAGING and KSP_ROOT now have defaults in all actions that use them, inputs are documented, readme updated

* Document listing unreferenced dependencies in a .csproj

* Better action input defaults when using env variables

Values will use the passed input, then the environment variable, then the hardcoded default, in that order.

* add install-ckan-mods and fix workflows

* Allow manually listing CKAN mods for the compile action

Slightly redundant with install-ckan-mods but its one line of bash so who cares

* Fix environment variable defaulting

Turns out env isnt usable in `input` after all, even though nektos-act supports it!

I figured using non-defaults for these values is so unbelievably rare that having an input isnt really needed anyways

* remove offending input line

* unbreak setup-ckan in debug mode

* fix debug and shush apt

* ok slightly less verbosity thanks

* remove double negative, document what these do

* missed one

---------

Co-authored-by: JonnyOThan <[email protected]>

Author: drewcassidy

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

@@ -2,11 +2,11 @@ name: assemble-release
 
 inputs:
   artifacts:
-    type: string
+    description: Space-separated list of file globs to include in the output artifact
     default: GameData LICENSE* README* CHANGELOG*
   output-file-name:
-    type: string
-    default: ${{ github.event.repository.name }}
+    description: Output artifact name
+    default: ${{ github.event.repository.name || 'release'}}
 
 outputs:
   artifact-id:
@@ -17,16 +17,20 @@ outputs:
 runs:
   using: composite
   steps:
+    - name: Set RELEASE_STAGING
+      if: ${{ !env.RELEASE_STAGING}}
+      shell: bash
+      run: echo 'KSP_ROOT=${{ '/tmp/release' }}' >> "$GITHUB_ENV"
+
     - name: Assemble Release
       shell: bash
       run: |
-        mkdir ${{ env.RELEASE_STAGING }}
+        mkdir -p ${{ env.RELEASE_STAGING  }}
         # TODO: delete pdb files?  run some kind of assembly script?
         cp -r -v ${{ inputs.artifacts }} ${{ env.RELEASE_STAGING }} || :
         cd ${{ env.RELEASE_STAGING }}
         zip -r ${{ github.workspace }}/${{ inputs.output-file-name }}.zip .
-        ARTIFACT_FILENAME="${{ inputs.output-file-name }}"
-        echo "ARTIFACT_FILENAME=$ARTIFACT_FILENAME" >> $GITHUB_ENV
+        echo 'ARTIFACT_FILENAME=${{ inputs.output-file-name }}' >> $GITHUB_ENV
 
     - name: Upload Artifact
       id: upload-artifact

.github/actions/compile/action.yml

@@ -1,61 +1,79 @@
 name: compile
+description: >
+  Compiles C# code using `msbuild` into a mod assembly.  
+  This action will install any dependent mods declared in the csproj file and restore NuGet packages.
 
 inputs:
   build-configuration:
-    type: string
     default: Release
+    description: The project configuration to build.  Defaults to `Release`.
+
   ksp-zip-url:
-    type: string
     default: https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip
+    description: >
+      A url for a zip file that contains the assemblies from the game to link against.  This should either be stripped 
+      so that it only contains public interfaces, or encrypted so that the libraries are not being redistributed unprotected.
+
+      Defaults to `https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip` which contains stripped versions 
+      of the libraries and should be suitable for most users. It does not require a password.
+
   ksp-zip-password:
-    type: string
-  dependency-identifiers:
-    type: string
-  msbuild-dependency-target:
-    type: string
+    description: >
+      If the ksp library zip is encrypted, this is the password.  It should be stored in your repository's secrets.
+
   solution-file-path:
-    type: string
+    description: >
+      The path to the solution file to build.  Defaults to empty, which will invoke `msbuild` on the root directory of 
+      the repo and builds any `*.sln` file it finds there.
+
+  ckan-identifiers:
+    description: Space-separated list of CKAN mod identifiers to install
+
 
 runs:
   using: composite
   steps:
 
     - name: dump contexts
       shell: bash
-      if: env.ACTIONS_STEP_DEBUG
+      if: runner.debug
       run: |
         echo "${{ toJson(env) }}"
         echo "${{ toJson(github )}}"
         echo "${{ toJson(job) }}"
         echo "${{ toJson(steps) }}"
         printenv
 
+    - name: Set KSP_ROOT
+      if: ${{ !env.KSP_ROOT }}
+      shell: bash
+      run: echo 'KSP_ROOT=${{ '/tmp/ksp' }}' >> "$GITHUB_ENV"
+
     - name: Setup .NET
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: 5.x
+        dotnet-version: 7.x
 
     - name: Install Dependencies
-      if: inputs.dependency-identifiers != '' || inputs.msbuild-dependency-target != ''
-      uses: KSPModdingLibs/KSPBuildTools/.github/actions/install-dependencies@main
-      with:
-        dependency-identifiers: ${{ inputs.dependency-identifiers }}
-        msbuild-dependency-target: ${{ inputs.msbuild-dependency-target }}
-        solution-file-path: ${{ inputs.solution-file-path }}
+      shell: bash
+      if: ${{ inputs.depedency-identifiers }}
+      run: ckan install --headless --no-recommends ${{ runner.debug && '--verbose' }} ${{ inputs.dependency-identifiers }}
 
     - name: Download KSP Libs
       shell: bash
       run: |
         wget --quiet ${{ inputs.ksp-zip-url }} -O /tmp/ksp.zip
         unzip -q -P "${{ inputs.ksp-zip-password }}" /tmp/ksp.zip -d "${{ env.KSP_ROOT }}"
 
-    - name: Restore NuGet Packages
+    - name: Restore Mod Solution
       shell: bash
       working-directory: ${{ github.workspace }}
-      run: nuget restore ${{ inputs.solution-file-path }}
+      run: dotnet restore ${{ inputs.solution-file-path }} ${{ runner.debug && '-v:detailed' }}
 
     - name: Build Mod Solution
       shell: bash
       working-directory: ${{ github.workspace }}
-      run: msbuild /p:Configuration=${{ inputs.build-configuration }} /p:KSPRoot=${{ env.KSP_ROOT }} /p:ManagedRelativePath=KSP_x64_Data/Managed ${{ inputs.solution-file-path }}
-
+      run: |
+        dotnet msbuild -p:Configuration=${{ inputs.build-configuration }} \
+        -p:ManagedRelativePath=KSP_x64_Data/Managed ${{ inputs.solution-file-path }} \
+        ${{ runner.debug && '-v:detailed' }}

.github/actions/install-dependencies/action.yml

@@ -1,83 +1,14 @@
-name: install-dependencies
+name: Install CKAN Mods
+description: Install listed dependencies using CKAN. Make sure you run the `setup-ckan` action first!
 
 inputs:
   dependency-identifiers:
-    type: string
-  msbuild-dependency-target:
-    type: string
-  solution-file-path:
-    type: string
-  ckan-compatible-versions:
-    type: string
-    default: |
-      1.12
-      1.11
-      1.10
-      1.9
-      1.8
-  ckan-filters:
-    type: string
-    default: |
-      .dds
-      .png
-      .bmp
-      .mu 
-      .mbm
-      .jpg
-      .wav
+    description: Space-separated list of CKAN mod identifiers to install
 
 runs:
   using: composite
   steps:
-    - name: ckan-install
+    - name: Install Mods
       shell: bash
-      run: |
-        sudo curl -sS -o /usr/share/keyrings/ksp-ckan-archive-keyring.gpg https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/debian/ksp-ckan.gpg
-        echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/ksp-ckan-archive-keyring.gpg] https://ksp-ckan.s3-us-west-2.amazonaws.com/deb stable main' | sudo tee /etc/apt/sources.list.d/ksp-ckan.list > /dev/null
-        sudo apt update
-        sudo apt install ckan
+      run: ckan install --headless --no-recommends ${{ runner.debug && '--verbose' }} ${{ inputs.dependency-identifiers }}
 
-    - name: ckan-setup-instance
-      shell: bash
-      run: |
-        ckan instance fake --set-default KSP ${{ env.KSP_ROOT }} 1.12.5 --game KSP --MakingHistory 1.9.1 --BreakingGround 1.7.1
-        ckan update
-        
-        versions="${{ inputs.ckan-compatible-versions }}"
-        for version in $versions; do
-          ckan compat add "$version"
-        done 
-        
-        filters="${{ inputs.ckan-filters }}"
-        for filter in $filters; do
-          ckan filter add "$filter"
-        done
-
-    - name: ckan-install-mod
-      if: inputs.dependency-identifiers != ''
-      shell: bash
-      run: |
-        identifiers="${{ inputs.dependency-identifiers}}"
-        ckan install --no-recommends --headless $identifiers
-
-    - name: Setup .NET
-      if: inputs.msbuild-dependency-target != ''
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: 5.x
-
-    - name: msbuild-dependency-target
-      if: inputs.msbuild-dependency-target != ''
-      shell: bash
-      working-directory: ${{ github.workspace }}
-      run: msbuild /t:${{ inputs.msbuild-dependency-target }} /p:KSPRoot=${{ env.KSP_ROOT }} ${{ inputs.solution-file-path }}
-
-    - name: debug
-      if: env.ACTIONS_STEP_DEBUG
-      shell: bash
-      run: |
-        ls -R ${{ env.KSP_ROOT }}/GameData
-        echo "${{ toJson(env) }}"
-        echo "${{ toJson(github )}}"
-        echo "${{ toJson(job) }}"
-        echo "${{ toJson(steps) }}"

.github/actions/publish-to-spacedock/action.yml

@@ -2,14 +2,14 @@ name: publish-to-spacedock
 
 inputs:
   spacedock-username:
-    type: string
+    description: Spacedock login username
   spacedock-password:
-    type: string
+    description: Spacedock login password. Store this as a secret!
   game-id:
-    type: number
-    default: 3102 # hardcoded to KSP1 gameid.  retrieve from https://spacedock.info/api/games
+    description: ID of the game we are deploying for. This should probably be left as-is for KSP 1.
+    default: '3102' # hardcoded to KSP1 gameid.  retrieve from https://spacedock.info/api/games
   mod-id:
-    type: number
+    description: ID of the mod we are deploying. Get this from the end of your mod's spacedock URL
 
 runs:
   using: composite
@@ -36,5 +36,5 @@ runs:
       if: false
       uses: KSP2Community/[email protected]
       with:
-        username: ${{ env.SPACEDOCK_USERNAME }}
-        password: ${{ env.SPACEDOCK_PASSWORD }}
+        username: ${{ inputs.spacedock-username }}
+        password: ${{ inputs.spacedock-password }}

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

@@ -0,0 +1,78 @@
+name: Setup CKAN
+description: Installs CKAN and sets up a KSP installation
+
+inputs:
+  ckan-version:
+    description: >
+      CKAN tag to install. set to an empty string to always install the most recent version. 
+      See https://github.com/KSP-CKAN/CKAN/tags for a list of available tags
+    default: ''
+
+  ckan-repo:
+    description: HOST/OWNER/REPO of the CKAN github repository to pull from. Defaults to the mainline version
+    default: 'https://github.com/KSP-CKAN/CKAN'
+
+  ckan-compatible-versions:
+    description: KSP versions to mark as compatible. newline-separated.
+    default: |
+      1.12
+      1.11
+      1.10
+      1.9
+      1.8
+
+  ckan-filters:
+    description: CKAN filters to enable. newline-separated
+    default: |
+      .dds
+      .png
+      .bmp
+      .mu 
+      .mbm
+      .jpg
+      .wav
+
+runs:
+  using: composite
+  steps:
+    - name: Set KSP_ROOT
+      if: ${{ !env.KSP_ROOT }}
+      shell: bash
+      run: echo 'KSP_ROOT=${{ '/tmp/ksp' }}' >> "$GITHUB_ENV"
+
+    - name: Install CKAN
+      shell: bash
+      run: |
+        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' }}
+        ckan version
+      env:
+        GH_TOKEN: ${{ github.token }}
+
+    - name: Setup CKAN 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
+      shell: bash
+      if: inputs.ckan-compatible-versions != ''
+      run: |
+        for version in $VERSIONS; do
+        ckan compat add "$version" ${{ runner.debug && '--verbose' }}
+        done
+      env:
+        VERSIONS: ${{ inputs.ckan-compatible-versions }}
+
+    - name: Setup CKAN Filter
+      shell: bash
+      if: inputs.ckan-filters != ''
+      run: |
+        for filter in $FILTERS; do
+        ckan filter add "$filter" ${{ runner.debug && '--verbose' }}
+        done
+      env:
+        FILTERS: ${{ inputs.ckan-filters }}

.github/workflow-templates/build-msbuild.yml

@@ -0,0 +1,42 @@
+name: build
+description: Build and assemble a KSP mod that uses csproj file.
+
+on:
+  push:
+    branches: [ $default-branch ]
+    paths:
+      - '**/*.cs'
+  pull_request:
+    paths:
+      - '**/*.cs'
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  build:
+    steps:
+      - name: Checkout Mod Repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      # Install CKAN and set up an instance. If CKAN is not needed, remove this step
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/setup-ckan@main
+
+      # Install any CKAN dependencies not in the msbuild file. If there are none, remove this step
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/install-dependencies@main
+        with:
+          # Any additional CKAN identifiers not listed in the csproj can be listed here. space-separated
+          dependency-identifiers: ""
+
+      # Compile the mod. 
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/compile@main
+        with:
+          ksp-zip-url: https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip
+          ksp-zip-password: ${{ secrets.ksp-zip-password }}
+
+      # Assemble the mod into a release package and upload it as an artifact
+      - uses: KSPModdingLibs/KSPBuildTools/.github/actions/assemble-release@main
+        with:
+          artifacts: "GameData LICENSE* README* CHANGELOG*"
+          output-file-name: ${{ github.event.repository.name }}-${{ inputs.build-configuration }}