Overhaul versioning and packaging

Author: joeyparrish

.github/workflows/build.yaml

@@ -60,21 +60,13 @@ jobs:
         run: |
           echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><Project ToolsVersion=\"Current\" xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\"><PropertyGroup><VALHEIM_INSTALL>$HOME/VHINSTALL/</VALHEIM_INSTALL></PropertyGroup></Project>" > Environment.props
 
-      - name: Set plugin version number
-        run: |
-          version=$(cat Pokeheim/Package/manifest.json | jq -r .version_number)
-          sed -e "s/PluginVersion = .*;/PluginVersion = \"$version\";/" \
-              -i Pokeheim/Pokeheim.cs
-          sed -e "s/(\"0.0.0.0\")/(\"$version.0\")/" \
-              -i Pokeheim/Properties/AssemblyInfo.cs
+      - name: Build debug version
+        run: ./scripts/build.sh Debug
 
-      - name: Build solution
+      - name: Build release zip
         run: |
-          ./scripts/build.sh Debug
-          ./scripts/build.sh Release
-
-      - name: Build zip
-        run: scripts/build-package-zip.sh
+          # Set a dummy version for CI builds generated on every push.
+          RELEASE_VERSION="0.0.1" ./scripts/build-package-zip.sh
 
       - uses: actions/upload-artifact@v2
         with:

.gitignore

@@ -175,9 +175,6 @@ DocProject/Help/*.hhp
 DocProject/Help/Html2
 DocProject/Help/html
 
-# Click-Once directory
-publish/
-
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml

Pokeheim/Package/unex.yml

@@ -28,7 +28,19 @@
 
 using Logger = Jotunn.Logger;
 
+[assembly: AssemblyTitle("Pokeheim")]
+[assembly: AssemblyProduct("Pokeheim")]
+[assembly: AssemblyCopyright("Copyright © 2021 Joey Parrish")]
+[assembly: AssemblyVersion(Pokeheim.ModVersion.String + ".0")]
+
 namespace Pokeheim {
+#if DEBUG
+  // This is generated at build time for releases.
+  public static class ModVersion {
+    public const string String = "0.0.1";
+  }
+#endif
+
   [BepInPlugin(PluginGUID, PluginName, PluginVersion)]
   // We are incompatible with AllTameable.
   [BepInIncompatibility("meldurson.valheim.AllTameable")]
@@ -42,7 +54,7 @@ public class PokeheimMod : BaseUnityPlugin {
     // BepInEx' plugin metadata
     public const string PluginGUID = "com.pokeheim";
     public const string PluginName = "Pokeheim";
-    public const string PluginVersion = "0.0.0";
+    public const string PluginVersion = ModVersion.String;
 
     internal static readonly Harmony harmony = new Harmony(PluginName);
     private static string PokeheimIntroFlag = "com.pokeheim.IntroSeen";

Pokeheim/Pokeheim.cs

@@ -38,6 +38,7 @@
     <WarningLevel>4</WarningLevel>
     <AllowUnsafeBlocks>false</AllowUnsafeBlocks>
     <Prefer32Bit>false</Prefer32Bit>
+    <CoreCompileDependsOn>GenerateVersionFile;$(CoreCompileDependsOn)</CoreCompileDependsOn>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="0Harmony, Version=2.10.0.0, Culture=neutral, PublicKeyToken=null">
@@ -84,7 +85,6 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Properties\IgnoreAccessModifiers.cs" />
     <Compile Include="Pokeheim.cs" />
     <Compile Include="Berries.cs" />
@@ -116,6 +116,24 @@
     <None Include="packages.config" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Target Name="GenerateVersionFile">
+    <PropertyGroup>
+      <ReleaseVersionCode>
+namespace Pokeheim {
+  public static class ModVersion {
+    public const string String = "$(RELEASE_VERSION)"%3B
+  }
+}
+      </ReleaseVersionCode>
+    </PropertyGroup>
+    <WriteLinesToFile
+        File="$(IntermediateOutputPath)ReleaseVersion.g.cs"
+        Lines="$(ReleaseVersionCode)"
+        Overwrite="true" />
+    <ItemGroup>
+      <Compile Include="$(IntermediateOutputPath)ReleaseVersion.g.cs" />
+    </ItemGroup>
+  </Target>
   <Target Name="EnsureEnvironmentPropsImport" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
       <ErrorText>This project needs a Environment.props file with the path to your Valheim installation. See https://github.com/Valheim-Modding/JotunnModStub. {0} is missing.</ErrorText>

Pokeheim/Pokeheim.csproj

@@ -1,6 +1,6 @@
 {
     "name": "Pokeheim",
-    "version_number": "1.0.0",
+    "version_number": "0.0.1",
     "website_url": "https://github.com/joeyparrish/pokeheim",
     "description": "Pokéheim - A Valheim mod about catching 'em all.",
     "dependencies": [

Pokeheim/Properties/AssemblyInfo.cs

@@ -1,32 +1,51 @@
 #!/bin/bash
 
+if [ -z "$RELEASE_VERSION" ]; then
+  echo "You must set the environment variable \$RELEASE_VERSION," 1>&2
+  echo "and use semantic versioning." 1>&2
+  exit 1
+fi
+
+# Fail on error.
 set -e
-set -x
 
+# Go to the project's root directory.
 cd "$(dirname "$0")"/..
 
+# Log steps.
+set -x
+
+# Build a clean release.
+rm -rf Pokeheim/bin/
 ./scripts/build.sh Release
 
+# Make a generic zip.
 rm -rf staging Pokeheim.zip
 mkdir -p staging/Pokeheim/Assets
+# Stage mod & assets.
 cp Pokeheim/bin/Release/Pokeheim.dll staging/Pokeheim/
 cp Pokeheim/Assets/*.png staging/Pokeheim/Assets/
 cp Pokeheim/Assets/*.mp3 staging/Pokeheim/Assets/
-cp Pokeheim/Package/{icon.png,manifest.json} staging/
-cp README.md staging/
 cp -a Pokeheim/Assets/Translations staging/Pokeheim/Assets/
+# Stage mod metadata.
+cp publish/icon.png staging/
+cp README.md staging/
+cat publish/manifest.json \
+    | jq ".version_number = \"$RELEASE_VERSION\"" \
+    > staging/manifest.json
+# Zip it.
 (cd staging; zip -r9 ../Pokeheim.zip *)
 
+# Stop logging.
 set +x
+
+# Double-check versioning.
 manifest_version=$(cat staging/manifest.json | jq -r .version_number)
 dll_version=$(monodis --assembly staging/Pokeheim/Pokeheim.dll \
               | grep Version | cut -f 2 -d : | tr -d ' ')
-
 if [[ "$manifest_version.0" != "$dll_version" ]]; then
   echo "Version mismatch!"
   echo "  Manifest version $manifest_version"
   echo "  DLL version $dll_version"
   exit 1
 fi
-
-rm -rf staging