Change assemble-release to no longer upload anything

as well as changing its outputs

Author: drewcassidy

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

@@ -2,7 +2,7 @@ name: Assemble Release
 
 x-env:
   RELEASE_STAGING:
-    description: The artifact files will be copied to this directory before being packaged in the zip file.  This becomes the input for `upload-artifact`. If not set, `/tmp/release` is used instead
+    description: The artifact files will be copied to this directory before being packaged in the zip file. If not set, `/tmp/release` is used instead
 
 inputs:
   artifacts:
@@ -30,17 +30,21 @@ outputs:
     value: ${{ steps.upload-artifact.outputs.artifact-url }}
     description: Artifact URL from the upload-artifact action
 
-  artifact-path:
-    value: ${{ steps.assemble-release.outputs.artifact-path }}
-    description: Local path to the produced zip file
+  artifact-zip-path:
+    value: ${{ steps.assemble-release.outputs.artifact-zip-path }}
+    description: Local path to the produced release zip file
+
+  artifact-dir-path:
+    value: ${{ steps.assemble-release.outputs.artifact-dir-path }}
+    description: Local path to the produced release directory
 
 runs:
   using: composite
   steps:
     - name: Set RELEASE_STAGING
       if: ${{ !env.RELEASE_STAGING}}
       shell: bash
-      run: echo 'RELEASE_STAGING=${{ '/tmp/release' }}' >> "$GITHUB_ENV"
+      run: echo 'RELEASE_STAGING=/tmp/release/' >> "$GITHUB_ENV"
 
     - name: Copy Files to Staging
       shell: bash
@@ -49,25 +53,16 @@ runs:
         shopt -s nocaseglob # so globs are case-insensitive
         shopt -s globstar
         shopt -s nullglob
-        mkdir -p ${{ env.RELEASE_STAGING  }}   
-        cp -r -v ${{ inputs.artifacts }} ${{ env.RELEASE_STAGING }}
-        cd ${{ env.RELEASE_STAGING }}
+        mkdir -p ${{ env.RELEASE_STAGING  }}/${{ inputs.output-file-name}}
+        cp -r -v ${{ inputs.artifacts }} ${{ env.RELEASE_STAGING }}/${{ inputs.output-file-name}}
+        cd ${{ env.RELEASE_STAGING }}/${{ inputs.output-file-name}}
         rm -f ${{ inputs.artifacts-exclude }}
 
     - name: Assemble Release
       id: assemble-release
       shell: bash
       working-directory: ${{ env.RELEASE_STAGING }}
       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 }}.zip' >> $GITHUB_OUTPUT
-
-    - name: Upload Artifact
-      id: upload-artifact
-      uses: actions/upload-artifact@v4
-      with:
-        path: ${{ env.RELEASE_STAGING }}
-        name: ${{ inputs.output-file-name }}
-        if-no-files-found: error
-        include-hidden-files: 'true' # behavior changed in 4.4.0. Include hidden for matching the behavior of `zip`
+        zip -r ${{ inputs.output-file-name }}.zip ${{ inputs.output-file-name}}
+        echo 'artifact-zip-path=${{ env.RELEASE_STAGING }}/${{ inputs.output-file-name }}.zip' >> $GITHUB_OUTPUT
+        echo 'artifact-dir-path=${{ env.RELEASE_STAGING }}/${{ inputs.output-file-name}}' >> $GITHUB_OUTPUT

.github/workflows/build.yml

@@ -79,8 +79,18 @@ jobs:
           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
+      # Assemble the mod into a release package
       - uses: KSPModdingLibs/KSPBuildTools/.github/actions/[email protected]
+        id: assemble-release
         with:
           artifacts: ${{ inputs.artifacts }}
-          output-file-name: ${{ github.event.repository.name }}-${{ inputs.build-configuration }}
+          output-file-name: ${{ github.event.repository.name }}
+
+      # Upload artifact
+      - uses: actions/upload-artifact@v4
+        id: upload-artifact
+        with:
+          path: ${{ steps.assemble-release.outputs.artifact-dir-path }}
+          name: ${{ github.event.repository.name }}-${{ inputs.build-configuration }}
+          if-no-files-found: error
+          include-hidden-files: 'true' # behavior changed in 4.4.0. Include hidden for matching the behavior of `zip`

.github/workflows/create-release.yml

@@ -111,4 +111,4 @@ jobs:
           GH_TOKEN: ${{ github.token }}
         run: |
           git push
-          gh release create "$VERSION_STRING" --draft --target ${{ github.ref_name }} --title "$VERSION_STRING" "$ARTIFACT_FILENAME.zip" --notes-file "$RELEASE_NOTES_FILE"
+          gh release create "$VERSION_STRING" --draft --target ${{ github.ref_name }} --title "$VERSION_STRING" "${{ steps.assemble-release.outputs.artifact-zip-path }}" --notes-file "$RELEASE_NOTES_FILE"

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

@@ -27,6 +27,14 @@ jobs:
           use-nuget-restore: true
 
       - uses: ./.github/actions/assemble-release
+        id: assemble-release
         with:
           artifacts: ${{ env.TESTDIR }}/GameData
           output-file-name: plugin-mod-legacy
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ${{ steps.assemble-release.outputs.artifact-dir-path }}
+          name: plugin-mod-legacy
+          if-no-files-found: error
+          include-hidden-files: 'true' # behavior changed in 4.4.0. Include hidden for matching the behavior of `zip`

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

@@ -48,6 +48,14 @@ jobs:
           KSPBuildToolsVersion: ${{ inputs.package-version }}
 
       - uses: ./.github/actions/assemble-release
+        id: assemble-release
         with:
           artifacts: ${{ env.TESTDIR }}/GameData
-          output-file-name: plugin-mod-nuget-${{ matrix.dotnet-version }}
+          output-file-name: plugin-mod-nuget
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ${{ steps.assemble-release.outputs.artifact-dir-path }}
+          name: plugin-mod-nuget-${{ matrix.dotnet-version }}
+          if-no-files-found: error
+          include-hidden-files: 'true' # behavior changed in 4.4.0. Include hidden for matching the behavior of `zip`

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

@@ -32,19 +32,9 @@ jobs:
           working-directory: ${{ env.TESTDIR }}
           output-file-name: plugin-mod
 
-      - name: Get github artifact
-        uses: actions/download-artifact@v4
+      - uses: actions/upload-artifact@v4
         with:
+          path: ${{ steps.assemble-release.outputs.artifact-dir-path }}
           name: plugin-mod
-          path: github-artifact
-
-      - name: Compare with zip artifact
-        run: |
-          unzip ${{ steps.assemble-release.outputs.artifact-path }} -d zip-artifact
-          
-          tree github-artifact
-          tree zip-artifact
-          
-          if [[ $(tree github-artifact/* | sed '1d') != $(tree zip-artifact/* | sed '1d') ]]; then echo "tree mismatch" && false; fi # fail if contents differ
-          if [[ ! -d github-artifact/GameData ]]; then echo "GameData not present" && false; fi # fail if GameData folder isnt present
-          if [[ -f github-artifact/GameData/plugin-mod/PluginMod.pdb ]]; then echo "pdb still present" && false; fi # fail if PDB is still present
+          if-no-files-found: error
+          include-hidden-files: 'true' # behavior changed in 4.4.0. Include hidden for matching the behavior of `zip`

CHANGELOG.md

@@ -29,7 +29,8 @@ All notable changes to this project will be documented in this file
 - `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)
+- `assemble-release` action: `outputs.artifact-path` was split into `outputs.artifact-zip-path` and `outputs.artifact-dir-path` containing paths to a zip file and directory respectively. These are also now located under `$RELEASE_STAGING` instead of inside the workspace
+- `assemble-release` action: Removed call to `actions/upload-artifact`. This should be done as a separate step.
 
 ### Library
 

docs/migration.md

@@ -39,7 +39,7 @@ would become
 
 ## CI Actions 
 
-### {gha:action}`compile`
+### {gha:action}`compile`:
 
 The compile action no longer runs `setup-dotnet`. You need to run this step separately.
 
@@ -53,6 +53,12 @@ If your mod uses a `packages.config` file, you need to specify `use-nuget-restor
 
 If your mod *does not* use a `packages.config` file, you can migrate your workflows on Github runners to use Ubuntu 24.04 or later.
 
+### {gha:action}`assemble-release`:
+
+The assemble release action no longer runs `upload-artifact`. You need to run this step separately.
+
+Additionally, the `artifact-path` output was split into `artifact-zip-path` and `artifact-dir-path` containing paths to a zip file and directory respectively. Use the correct one depending on if you want a directory or a zip.
+
 ## Library
 
 If you made use of the logging utilities under the `KSPBuildTools` namespace, you should migrate to [KSPCommunityLib](https://git.offworldcolonies.nexus/KSPModdingLibs/KSPCommunityLib) instead.