v6.7.0

.github/CONTRIBUTING.md

@@ -73,7 +73,8 @@ For the full CI gambit, the following repository configuration must be set:
 
 If you don't plan on deploying TGS, the following secrets can be omitted:
 
-- Secret `DEV_PUSH_TOKEN`: A GitHub token with read/write access to the repository. Enables doxygen pushes to `gh-pages` branch, and releases creation.
+- Secret `DEV_PUSH_TOKEN`: A repo scoped GitHub PAT with read/write access on the repository and the ability to trigger workflows on https://github.com/tgstation/tgstation-ppa. Used to trigger debian repo rebuilds, bypass rate limits, update milestones, and create winget package acceptance PRs.
+- Secret `TGS_CI_GITHUB_APP_TOKEN_BASE64` is a base 64 encoded private key for a GitHub App. This app must be installed on the repo and have read/write access to checks and contents. Used to generate CI checks, push changelogs, and create releases.
 - Secret `DOCKER_USERNAME`: Login username for Docker image push.
 - Secret `DOCKER_PASSWORD`: Login password for Docker image push.
 - Secret `NUGET_API_KEY`: Nuget.org API Key for client libraries push.

.github/workflows/ci-pipeline.yml

@@ -42,7 +42,6 @@ env:
   TGS_DOTNET_QUALITY: ga
   TGS_TEST_GITHUB_TOKEN: ${{ secrets.LIVE_TESTS_TOKEN }}
   TGS_RELEASE_NOTES_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
-  WINGET_PUSH_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
   PACKAGING_PRIVATE_KEY_PASSPHRASE: ${{ secrets.PACKAGING_PRIVATE_KEY_PASSPHRASE }}
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
@@ -315,6 +314,12 @@ jobs:
         mv $HOME/tgsdox/changelog.yml ./ 2>/dev/null
         dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --generate-full-notes
 
+    - name: Generate App Token
+      run: |
+        dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --token-output-file ${{ runner.temp }}/installation_secret.txt ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
+        echo "INSTALLATION_TOKEN=$(cat ${{ runner.temp }}/installation_secret.txt)" >> $GITHUB_ENV
+        rm ${{ runner.temp }}/installation_secret.txt
+
     - name: Patch Doxyfile
       run: |
         VERSION=$(cat "build/Version.props" | grep -oPm1 "(?<=<TgsCoreVersion>)[^<]+")
@@ -335,8 +340,8 @@ jobs:
         echo ./doxout/* | xargs -n 10 sudo mv -t $HOME/tgsdox
         cd $HOME/tgsdox
         git config --global push.default simple
-        git config user.name "tgstation-server"
-        git config user.email "tgstation-server@tgstation13.org"
+        git config user.name "tgstation-server-ci[bot]"
+        git config user.email "161980869+tgstation-server-ci[bot]@users.noreply.github.com"
         echo '# THIS BRANCH IS AUTO GENERATED BY GITHUB ACTIONS' > README.md
 
         # Need to create a .nojekyll file to allow filenames starting with an underscore
@@ -347,7 +352,7 @@ jobs:
         echo "Committing..."
         git diff-index --quiet HEAD || git commit -m "Deploy code docs to GitHub Pages for workflow run ${{ github.run_number }}" -m "Commit: ${{ github.event.head_commit.id }}"
         echo "Pushing..."
-        git push -f "https://${{ secrets.DEV_PUSH_TOKEN }}@github.com/tgstation/tgstation-server" 2>&1
+        git push -f "https://tgstation-server-ci:${{ env.INSTALLATION_TOKEN }}@github.com/tgstation/tgstation-server" 2>&1
 
   docker-build:
     name: Build Docker Image
@@ -1233,7 +1238,7 @@ jobs:
     - name: Install winget
       uses: Cyberboss/install-winget@v1
       with:
-        GITHUB_TOKEN: ${{ env.WINGET_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
 
     - name: Setup dotnet
       uses: actions/setup-dotnet@v4
@@ -1480,11 +1485,19 @@ jobs:
     - name: Generate Release Notes
       run: dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes ${{ env.TGS_API_VERSION }} --httpapi
 
+    - name: Generate App Token
+      shell: powershell
+      run: |
+        dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --token-output-file ${{ runner.temp }}/installation_secret.txt ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
+        $installSecret = Get-Content ${{ runner.temp }}/installation_secret.txt
+        echo "INSTALLATION_TOKEN=$installSecret" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+        rm ${{ runner.temp }}/installation_secret.txt
+
     - name: Create GitHub Release
       uses: actions/create-release@v1
       id: create_release
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         tag_name: api-v${{ env.TGS_API_VERSION }}
         release_name: tgstation-server API v${{ env.TGS_API_VERSION }}
@@ -1494,7 +1507,7 @@ jobs:
     - name: Upload OpenApi Spec
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./swagger/tgs_api.json
@@ -1543,11 +1556,19 @@ jobs:
     - name: Generate Release Notes
       run: dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes ${{ env.TGS_DM_VERSION }} --dmapi
 
+    - name: Generate App Token
+      shell: powershell
+      run: |
+        dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --token-output-file ${{ runner.temp }}/installation_secret.txt ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
+        $installSecret = Get-Content ${{ runner.temp }}/installation_secret.txt
+        echo "INSTALLATION_TOKEN=$installSecret" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+        rm ${{ runner.temp }}/installation_secret.txt
+
     - name: Create GitHub Release
       uses: actions/create-release@v1
       id: create_release
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         tag_name: dmapi-v${{ env.TGS_DM_VERSION }}
         release_name: tgstation-server DMAPI v${{ env.TGS_DM_VERSION }}
@@ -1557,7 +1578,7 @@ jobs:
     - name: Upload DMAPI Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./DMAPI.zip
@@ -1637,7 +1658,7 @@ jobs:
       run: dotnet build -c Release -p:TGS_HOST_NO_WEBPANEL=true tools/Tgstation.Server.ReleaseNotes/Tgstation.Server.ReleaseNotes.csproj
 
     - name: Run ReleaseNotes with --ensure-release
-      run: dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --ensure-release
+      run: dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --ensure-release ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
 
   deploy-tgs:
     name: Deploy TGS
@@ -1760,11 +1781,19 @@ jobs:
     - name: Generate Release Notes
       run: dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes ${{ env.TGS_VERSION }}
 
+    - name: Generate App Token
+      shell: powershell
+      run: |
+        dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --token-output-file ${{ runner.temp }}/installation_secret.txt ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
+        $installSecret = Get-Content ${{ runner.temp }}/installation_secret.txt
+        echo "INSTALLATION_TOKEN=$installSecret" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+        rm ${{ runner.temp }}/installation_secret.txt
+
     - name: Create GitHub Release
       uses: actions/create-release@v1
       id: create_release
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         tag_name: tgstation-server-v${{ env.TGS_VERSION }}
         release_name: tgstation-server-v${{ env.TGS_VERSION }}
@@ -1774,7 +1803,7 @@ jobs:
     - name: Upload Server Console Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./ServerConsole.zip
@@ -1784,7 +1813,7 @@ jobs:
     - name: Upload Server Service Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./ServerService.zip
@@ -1794,7 +1823,7 @@ jobs:
     - name: Upload DMAPI Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./DMAPI.zip
@@ -1804,7 +1833,7 @@ jobs:
     - name: Upload OpenApi Spec Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./swagger/tgs_api.json
@@ -1814,7 +1843,7 @@ jobs:
     - name: Upload Server Update Package Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./ServerUpdatePackage.zip
@@ -1824,7 +1853,7 @@ jobs:
     - name: Upload Debian Pacakaging Artifact
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./packaging-debian/tgstation-server-v${{ env.TGS_VERSION }}.debian.packaging.tar.xz
@@ -1834,7 +1863,7 @@ jobs:
     - name: Upload MariaDB .msi
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./build/package/winget/Tgstation.Server.Host.Service.Wix.Bundle/bin/Release/mariadb.msi
@@ -1844,7 +1873,7 @@ jobs:
     - name: Upload Installer .exe
       uses: actions/upload-release-asset@v1
       env:
-        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ env.INSTALLATION_TOKEN }}
       with:
         upload_url: ${{ steps.create_release.outputs.upload_url }}
         asset_path: ./build/package/winget/tgstation-server-installer.exe
@@ -1880,6 +1909,12 @@ jobs:
         mv $HOME/tgsdox/changelog.yml ./ 2>/dev/null
         dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --generate-full-notes
 
+    - name: Generate App Token
+      run: |
+        dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --token-output-file ${{ runner.temp }}/installation_secret.txt ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
+        echo "INSTALLATION_TOKEN=$(cat ${{ runner.temp }}/installation_secret.txt)" >> $GITHUB_ENV
+        rm ${{ runner.temp }}/installation_secret.txt
+
     - name: gh-pages Push
       run: |
         pushd $HOME/tgsdox
@@ -1888,13 +1923,13 @@ jobs:
         sudo mv changelog.yml $HOME/tgsdox/
         cd $HOME/tgsdox
         git config --global push.default simple
-        git config user.name "tgstation-server"
-        git config user.email "tgstation-server@tgstation13.org"
+        git config user.name "tgstation-server-ci[bot]"
+        git config user.email "161980869+tgstation-server-ci[bot]@users.noreply.github.com"
         git add changelog.yml
         echo "Committing..."
         git diff-index --quiet HEAD || git commit -m "Regenerate changelog post deploy for workflow run ${{ github.run_number }}" -m "Commit: ${{ github.event.head_commit.id }}"
         echo "Pushing..."
-        git push -f "https://${{ secrets.DEV_PUSH_TOKEN }}@github.com/tgstation/tgstation-server" 2>&1
+        git push -f "https://tgstation-server-ci:${{ env.INSTALLATION_TOKEN }}@github.com/tgstation/tgstation-server" 2>&1
 
   deploy-docker:
     name: Deploy TGS (Docker)
@@ -1954,7 +1989,7 @@ jobs:
     - name: Install winget
       uses: Cyberboss/install-winget@v1
       with:
-        GITHUB_TOKEN: ${{ env.WINGET_PUSH_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}
 
     - name: Install wingetcreate
       run: winget install wingetcreate --version 1.2.8.0 --disable-interactivity --accept-source-agreements # Pinned due to breaking every other version

.github/workflows/stable-merge.yml

@@ -1,20 +1,43 @@
 name: 'Master Merge'
 
 on:
-  workflow_run:
-    workflows: [CI Pipeline]
-    types:
-    - completed
+  push:
+    branches:
+    - master
+  workflow_dispatch:
 
 jobs:
   master-merge:
+    name: Master Merge
     runs-on: ubuntu-latest
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
-    - name: Checkout
+    - name: Build Checkout
+      uses: actions/checkout@v4
+      with:
+        path: temp_workspace
+
+    - name: Restore
+      run: |
+        cd temp_workspace
+        dotnet restore
+
+    - name: Build ReleaseNotes
+      run: |
+        cd temp_workspace
+        dotnet build -c Release -p:TGS_HOST_NO_WEBPANEL=true tools/Tgstation.Server.ReleaseNotes/Tgstation.Server.ReleaseNotes.csproj
+
+    - name: Generate App Token
+      run: |
+        cd temp_workspace
+        dotnet run -c Release --no-build --project tools/Tgstation.Server.ReleaseNotes --token-output-file ${{ runner.temp }}/installation_secret.txt ${{ secrets.TGS_CI_GITHUB_APP_TOKEN_BASE64 }}
+        echo "INSTALLATION_TOKEN=$(cat ${{ runner.temp }}/installation_secret.txt)" >> $GITHUB_ENV
+        rm ${{ runner.temp }}/installation_secret.txt
+
+    - name: Main Checkout
       uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        token: ${{ env.INSTALLATION_TOKEN }}
 
     - name: Merge master into dev
       uses: robotology/gh-action-nightly-merge@14b4a4cf358f7479aa708bee05cf8a794d6a2516 #v1.5.0
@@ -23,9 +46,8 @@ jobs:
         development_branch: 'dev'
         allow_ff: true
         allow_forks: true
-        user_name: tgstation-server
-        user_email: [email protected]
-        push_token: DEV_PUSH_TOKEN
+        user_name: tgstation-server-ci[bot]
+        user_email: 847638+tgstation-server-ci[bot]@users.noreply.github.com
+        push_token: INSTALLATION_TOKEN
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        DEV_PUSH_TOKEN: ${{ secrets.DEV_PUSH_TOKEN }}

build/NewtonsoftJson.props

@@ -0,0 +1,6 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <!-- Usage: Primary JSON library -->
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+  </ItemGroup>
+</Project>

build/TestCommon.props

@@ -18,9 +18,9 @@
     <!-- Pinned: Be VERY careful about updating https://github.com/moq/moq/issues/1372 -->
     <PackageReference Include="Moq" Version="4.20.70" />
     <!-- Usage: MSTest execution -->
-    <PackageReference Include="MSTest.TestAdapter" Version="3.4.3" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.5.0" />
     <!-- Usage: MSTest asserts etc... -->
-    <PackageReference Include="MSTest.TestFramework" Version="3.4.3" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.5.0" />
   </ItemGroup>
 
 </Project>

build/Version.props

@@ -3,13 +3,13 @@
   <!-- Integration tests will ensure they match across the board -->
   <Import Project="WebpanelVersion.props" />
   <PropertyGroup>
-    <TgsCoreVersion>6.6.1</TgsCoreVersion>
+    <TgsCoreVersion>6.7.0</TgsCoreVersion>
     <TgsConfigVersion>5.1.0</TgsConfigVersion>
-    <TgsApiVersion>10.4.0</TgsApiVersion>
+    <TgsApiVersion>10.5.0</TgsApiVersion>
     <TgsCommonLibraryVersion>7.0.0</TgsCommonLibraryVersion>
-    <TgsApiLibraryVersion>13.4.0</TgsApiLibraryVersion>
-    <TgsClientVersion>15.4.0</TgsClientVersion>
-    <TgsDmapiVersion>7.1.2</TgsDmapiVersion>
+    <TgsApiLibraryVersion>13.5.0</TgsApiLibraryVersion>
+    <TgsClientVersion>15.5.0</TgsClientVersion>
+    <TgsDmapiVersion>7.1.3</TgsDmapiVersion>
     <TgsInteropVersion>5.9.0</TgsInteropVersion>
     <TgsHostWatchdogVersion>1.4.1</TgsHostWatchdogVersion>
     <TgsContainerScriptVersion>1.2.1</TgsContainerScriptVersion>

build/WebpanelVersion.props

@@ -1,6 +1,6 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <!-- This is in it's own file to help incremental building, changing it causes a complete rebuild of the web panel -->
-    <TgsWebpanelVersion>5.8.0</TgsWebpanelVersion>
+    <TgsWebpanelVersion>5.9.0</TgsWebpanelVersion>
   </PropertyGroup>
 </Project>

build/package/winget/.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "wix": {
-      "version": "4.0.4",
+      "version": "5.0.1",
       "commands": [
         "wix"
       ]

build/package/winget/Tgstation.Server.Host.Service.Wix.Bundle/Tgstation.Server.Host.Service.Wix.Bundle.wixproj

@@ -1,4 +1,4 @@
-<Project Sdk="WixToolset.Sdk/4.0.4" xmlns:bal="http://schemas.microsoft.com/wix/BalExtension">
+<Project Sdk="WixToolset.Sdk/5.0.1" xmlns:bal="http://schemas.microsoft.com/wix/BalExtension">
   <Import Project="../../../Common.props" />
   <PropertyGroup>
     <DefineConstants>ProductVersion=$(TgsCoreVersion);NetMajorVersion=$(TgsNetMajorVersion);DotnetRedistUrl=$(TgsDotnetRedistUrl);MariaDBRedistUrl=https://github.com/tgstation/tgstation-server/releases/download/tgstation-server-v$(TgsCoreVersion)/mariadb-$(TgsMariaDBRedistVersion)-winx64.msi</DefineConstants>
@@ -24,8 +24,8 @@
     <Content Include="Theme.xml" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="WixToolset.Bal.wixext" Version="4.0.4" />
-    <PackageReference Include="WixToolset.Netfx.wixext" Version="4.0.4" />
+    <PackageReference Include="WixToolset.Bal.wixext" Version="5.0.1" />
+    <PackageReference Include="WixToolset.Netfx.wixext" Version="5.0.1" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Tgstation.Server.Host.Service.Wix\Tgstation.Server.Host.Service.Wix.wixproj" />