Gum

MonoGame Gum (NuGet Packages)

Team City has an automated build which runs whenever anything is pushed (assuming Vic's desktop is turned on). This attempts to build Gum (the tool) and the .NET 6 libraries use for MonoGameGum. If the builds succeeds it also attempts to upload a new nuget package.

The automated build will not upload a new NuGet if the version number is not manually increased first. Also note, this DOES NOT currently upload a new Gum tool - this must be done manually (see steps below).

To upload a new NuGet packages, follow these steps:

1. Open AllLibraries.sln in Visual Studio - this links MonoGame/FNA/Kni Gum and the projects it depends on. It is at <GumRoot>\MonoGameGum.sln

2. Double-click GumCommon and find the version. Copy this, then do a global find/replace to upate all versions to the latest version.

   

   Setting GumCommon's Version number
3. at the time of this writing, 7 projects will be updated.

4. Save the files and push the commit

If Vic's computer is on, it will automatically build. If not, Vic must open it and manually run a build.

Troubleshooting Gum Automatic Builds

Vic has noticed that sometimes the build will fail due to the referenced ColorPicker not being available. If the same .sln (in the build folder indicated in TeamCity logs) is opened and built in VS 2019, the manual build works. Then if TeamCity is run again, all works. This is a hacky workaround.

Gum Tool

Currently Gum uses .NET 4.7.1. This will not build using dotnet build (not sure why). Therefore, Gum must be built and uploaded manually. We could eventually automate this through TeamCity until Gum (maybe?) gets updated to modern .NET. Until then the steps are:

1. Open Gum locally in Visual Studio

2. Open Gum AssemblyInfo.cs and set AssemblyVersion and AssemblyFileVersion using the date-based format. Notice that there's only 3 numbers unlike the versions for NuGet packages.

   

   AssemblyVersion and AssemblyFileVersion in AssemblyInfo.cs
3. Rebuild the entire solution (not just the Gum project)

4. Navigate to the location where Gum is built

5. Go up one folder so that you are outside of the Debug folder

6. Create a Data folder if one doesn't exist and copy the Debug folder into it

7. Right-click on Data and Zip it. This will produce a .zip that has a Data folder inside - this matches the expected folder structure from previous builds so make sure this is the case

8. Rename this Gum.zip

9. Manually upload this to FlatRedBall's Files folder using sftp to /home/frbfiles/files.flatredball.com/content/Tools/Gum/Gum.zip

10. Create a new release on Github - see the previous releases for examples

11. Add a new page in the Gum Upgrade section explaining how to upgrade this version. If no changes are needed, explain that the upgrade can happen without any changes.

12. Announce on FRB discord

13. Announce on MonoGame discord

14. Announce on MGE discord

15. Announce on Kni discord

16. Announce on twitter

17. Announce on Blue Sky

This file is used when creating FlatRedBall builds, so Gum must first be built and uploaded to the FlatRedBall FTP prior to running the FlatRedBall Github Actions. Otherwise, an old Gum will be included in FRBDK. This may be okay depending on if Gum has important new features.