Failure to build 1.0-rc1 release tarball with MESA SDK 21.4.1 on Fedora 36

[warrickball]

I just tried to build 1.0-rc1 by following the instructions in the Quick Start, specifically:

$ export MESASDK_ROOT=$HOME/mesa/sdk/21.4.1
$ source $MESASDK_ROOT/bin/mesasdk_init.sh
$ tar -xf ~/Downloads/msg-1.0-rc1.tar.gz # after clicking the release link
$ cd msg-1.0-rc1
$ export MSG_DIR=$(pwd)
$ make -C $MSG_DIR

and ran into the error

$ make -C $MSG_DIR
make: Entering directory '/home/wball/code/msg/1.0-rc1'
../src/lib/cmsg_m.fypp:18: error: include file 'forum.inc' not found [FyppFatalError]
../src/lib/fmsg_m.fypp:18: error: include file 'forum.inc' not found [FyppFatalError]
../src/lib/msg_m.fypp:18: error: include file 'forum.inc' not found [FyppFatalError]
../src/lib/forum_m.fypp:18: error: include file 'forum.inc' not found [FyppFatalError]
make[1]: *** No rule to make target 'forum_m.f90', needed by 'forum_m.o'.  Stop.
make: *** [Makefile:15: all] Error 2
make: Leaving directory '/home/wball/code/msg/1.0-rc1'

I noticed that forum is a git submodule in a separate repo. There's an empty folder under $MSG_DIR/src/forum, too.

$ find . -iname *forum*
./src/forum
./src/lib/forum_m.fypp
./build/.forum_m.dpp

The instructions for cloning the git repo and installing the development version do end with a successful build, so I suspect the relevant files from forum aren't being correctly included in the GitHub release archive.

[rhdtownsend]

Thanks, Warrick -- this is why one has release candidates, I guess. You're correct about the submodule not being included in the tarball; this is an annoying feature of GitHub that I'd forgotten about (see, e.g., AcademySoftwareFoundation/MaterialX#317).

I'll get this fixed in the docs and push out rc2 later today.

[rhdtownsend]

OK, rc2 is live -- give it a whirl!

[warrickball]

Success, thank you! I don't know how long 1.0-rc2 might live but you might want to link to the actual tarball (on your personal site) from the GitHub release page. I confused myself with various versions of the ReadTheDocs pages before finding the correct link.

Also, perhaps worth adding this to the troubleshooting page. I'm happy to open a PR to document this¹ but it won't happen until at least next week.

¹ i.e., "if you see this error, see if the forum code is there and if not make sure you didn't get archive from GitHub or make sure you clone with --recurse-submodules".

[rhdtownsend]

Added a link on the release page, and added the troubleshooting item as suggested (on main, will be in the next rc or in the full release).

[warrickball]

This all looks good / is working for me, so you're welcome to close this.