Add step to create release draft and upload zip (#432)

* Add step to create release draft and upload zip

* Skip draft creation for release candidates

* Zip folder before upload and give permission

The action we use can only deal with single files, not folders

* Use `env.NORTHSTAR_VERSION`

* Check if tags start with `v`

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: Build
 on:
   push:
     tags:
-      - '*'
+      - 'v*'
   workflow_dispatch:
     inputs:
       job:
@@ -10,6 +10,9 @@ on:
         required: true
         default: 'build-thunderstore-package'
 
+permissions:
+  contents: write # Needed to write to GitHub draft release
+
 env:
   NORTHSTAR_VERSION: ${{ github.ref_name }}
 
@@ -18,12 +21,13 @@ jobs:
     runs-on: windows-2022
     steps:
       - name: Setup bundled plugins
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: R2Northstar/NorthstarDiscordRPC
+          ref: 'v1'
           path: discord-plugin
       - name: Checkout launcher repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: R2Northstar/NorthstarLauncher
           ref: ${{ env.NORTHSTAR_VERSION }}
@@ -34,9 +38,9 @@ jobs:
         shell: bash
         working-directory: northstar-launcher
         run: |
-          sed -i 's/DEV/${{ env.NORTHSTAR_VERSION }}/g' LauncherInjector/resources.rc
+          sed -i 's/DEV/${{ env.NORTHSTAR_VERSION }}/g' NorthstarLauncher/resources.rc
           FILEVERSION=$(echo ${{ env.NORTHSTAR_VERSION }} | tr '.' ',' | sed -E 's/-rc[0-9]+//' | tr -d '[:alpha:]')
-          sed -i "s/0,0,0,1/${FILEVERSION}/g" NorthstarDedicatedTest/ns_version.h
+          sed -i "s/0,0,0,1/${FILEVERSION}/g" NorthstarDLL/ns_version.h
       - name: Build
         working-directory: northstar-launcher
         run: |
@@ -44,7 +48,7 @@ jobs:
           msbuild /p:Configuration=Release R2Northstar.sln
           msbuild /p:Configuration=Release NorthstarDiscordRPC.sln
       - name: Upload launcher build as artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: northstar-launcher
           path: |
@@ -55,7 +59,7 @@ jobs:
             northstar-launcher/x64/Release/DiscordRPC.dll
             northstar-launcher/x64/Release/*.txt
       - name: Upload debug build artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: launcher-debug-files
           path: |
@@ -74,12 +78,12 @@ jobs:
         run:
           wget "https://github.com/R2Northstar/NorthstarStubs/releases/download/v1/NorthstarStubs.zip"
       - name: Checkout release files
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ env.NORTHSTAR_VERSION }}
           path: northstar
       - name: Checkout core mods
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: R2Northstar/NorthstarMods
           ref: ${{ env.NORTHSTAR_VERSION }}
@@ -110,9 +114,10 @@ jobs:
           mv -v northstar-launcher/* northstar
           rsync -avr --exclude="Northstar.Coop" --exclude=".git*" northstar-mods/. northstar/R2Northstar/mods
       - name: Checkout Navmesh repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: R2Northstar/NorthstarNavs
+          ref: 'v1'
           path: northstar-navs
       - name: Navmeshes setup
         run: |
@@ -124,14 +129,24 @@ jobs:
         run: |
           rm -rf .git .github .gitignore *.md LICENSE thunderstore .ci.env.example
       - name: Upload
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: Northstar.release.${{ env.NORTHSTAR_VERSION }}
           path: northstar
+      - name: Create zip to upload
+        run: |
+          cd northstar/
+          zip --recurse-paths --quiet Northstar.release.${{ env.NORTHSTAR_VERSION }}.zip .
+          mv Northstar.release.${{ env.NORTHSTAR_VERSION }}.zip ../
+      - name: Upload zip to release draft
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/v') && !contains(env.NORTHSTAR_VERSION, '-rc')
+        with:
+          draft: true
+          files: Northstar.release.${{ env.NORTHSTAR_VERSION }}.zip
 
   build-thunderstore-package:
     needs: build-northstar # comment out when running locally
-    if: "!contains(github.ref, 'rc')" # Skip uploading release candidates to Thunderstore
     env:
       # Release envs, comment this out when running locally
       TCLI_AUTH_TOKEN: ${{ secrets.THUNDERSTORE_TOKEN }}
@@ -169,14 +184,25 @@ jobs:
       - name: Make package structure
         run: |
           mkdir -p thunderstore/dist/Northstar
-          rm northstar/ns_startup*.txt
           mv -v northstar/* thunderstore/dist/Northstar
           wget -O thunderstore/icon.png https://raw.githubusercontent.com/R2Northstar/Northstar/main/thunderstore/icon.png
           wget -O thunderstore/README.md https://raw.githubusercontent.com/R2Northstar/Northstar/main/thunderstore/README.md
 
       - name: Setup environment variables
         run: |
-          echo "MOD_VERSION=$(echo $NORTHSTAR_VERSION | tr -d 'v')" >> $GITHUB_ENV
+          # Strip leading `v` and if exists replace `-rc` with `0` and strip leading zeroes from last semver digit if necessary
+          echo "MOD_VERSION=$(echo $NORTHSTAR_VERSION | tr -d 'v'| sed --expression 's/-rc/0/' | sed -E 's/([0-9]+)\.([0-9]+)\.(0*)([0-9])/\1.\2.\4/;')" >> $GITHUB_ENV
+
+          # If it's a release candidate we also want to change a few things
+          if [[ $NORTHSTAR_VERSION == *"-rc"* ]]; then
+            # We want to push to a different package
+            # i.e. `NorthstarReleaseCandidate` vs `Northstar`
+            echo "TS_MOD_NAME=NorthstarReleaseCandidate" >> $GITHUB_ENV
+            # And update mod description
+            echo "TS_MOD_DESCRIPTION=Release candidate for next Northstar release." >> $GITHUB_ENV
+            # Add disclaimer add the top of README
+            echo -e '> ⚠️ This is a release candidate. Please report bugs or other issues on GitHub ⚠️\n' | cat - thunderstore/README.md > temp && mv temp thunderstore/README.md
+          fi
 
       - name: Publish package to Thunderstore
         working-directory: thunderstore

README.md

@@ -1,6 +1,7 @@
 # Northstar
 
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/R2Northstar/Northstar)](https://github.com/R2Northstar/Northstar/releases)
+![GitHub release downloads (latest by date)](https://img.shields.io/github/downloads/R2Northstar/Northstar/latest/total)
 [![Join the chat at Discord](https://img.shields.io/badge/chat-on%20discord-7289DA.svg)](https://northstar.tf/discord)
 [![Read the wiki](https://img.shields.io/badge/wiki-GitBook-important)](https://r2northstar.gitbook.io)
 
@@ -12,12 +13,13 @@ Northstar is a modding framework client that allows users to host their own Tita
 
 ## Development
 
-Northstar's development is split into 4 repositories:
+Northstar's development is split into 5 repositories:
 
 1. [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher) (Code for the C++ hook DLL)
 1. [NorthstarMods](https://github.com/R2Northstar/NorthstarMods) (Code for the squirrel mods responsible for server gamelogic recreation and custom content)
 1. [NorthstarMasterServer](https://github.com/R2Northstar/NorthstarMasterServer) (Responsible for server browser, authentication and persistence)
 1. [NorthstarStubs](https://github.com/R2Northstar/NorthstarStubs) (D3D11 and GFSDK stubs for the Northstar dedicated server)
+1. [NorthstarNavs](https://github.com/R2Northstar/NorthstarNavs) (Custom navmesh files used for AI navigation)
 
 The documentation is split into two repositories:
 1. [NorthstarWiki](https://github.com/R2Northstar/NorthstarWiki) (Wiki covering installation, hosting and configuration of Northstar)

release/ns_startup_args.txt

@@ -1 +0,0 @@
--multiple

release/ns_startup_args_dedi.txt

@@ -1 +0,0 @@
-+setplaylist private_match