Update from head 11/5/26

.editorconfig

@@ -30,3 +30,7 @@ indent_size = 4
 [*.py]
 indent_style = space
 indent_size = 4
+
+# Markdown Files
+[*.md]
+indent_size = unset

.github/linters/.ruff.toml

@@ -0,0 +1,11 @@
+# Store the cache in a temporary location
+cache-dir = "/tmp/.ruff_cache"
+
+# Same as Black
+line-length = 88
+
+# Oldest Python on supported distros (Ubuntu 20.04)
+target-version = "py38"
+
+[lint]
+ignore = ["E203"]

.github/pull_request_template.md

@@ -1,20 +1,23 @@
 # Description
 
-Please include a summary of the change and which issues are fixed.
+<!-- Summarise the change and why it is needed. -->
 
 Fixes #[issue]
 
+Affected servers: <!-- shortnames, e.g. ck, rust, or "all" -->
+
 ## Type of change
 
 - [ ] Bug fix (a change which fixes an issue).
 - [ ] New feature (a change which adds functionality).
 - [ ] New Server (new server added).
 - [ ] Refactor (restructures existing code).
+- [ ] Chore (CI, workflows, tooling or other maintenance).
 - [ ] Comment update (typo, spelling, explanation, examples, etc).
 
 ## Testing
 
-Please list the exact validation you performed and the outcome.
+<!-- List the exact validation you performed and the outcome. -->
 
 - Commands/tests run:
 - Result:
@@ -30,28 +33,23 @@ Please list the exact validation you performed and the outcome.
 - [ ] No breaking changes.
 - [ ] Breaking changes included (describe below).
 
-## Documentation impact
+## Documentation
+
+<!-- If documentation needs updating, open a PR on the docs repo (preferred) or request an update. -->
 
 - [ ] No documentation update required.
-- [ ] User documentation update required.
-- [ ] Developer documentation update required.
+- [ ] User documentation update required ([LinuxGSM-Docs](https://github.com/GameServerManagers/LinuxGSM-Docs)).
+- [ ] Developer documentation update required ([LinuxGSM-Dev-Docs](https://github.com/GameServerManagers/LinuxGSM-Dev-Docs)).
 
 ## Checklist
 
 PR will not be merged until all steps are complete.
 
-- [ ] This pull request links to an issue.
+- [ ] This pull request links to an issue ("Fixes", or "Related to" for a partial fix).
 - [ ] This pull request uses the develop branch as its base.
 - [ ] This pull request subject follows the Conventional Commits standard.
 - [ ] This code follows the style guidelines of this project.
 - [ ] I have performed a self-review of my code.
 - [ ] I have provided a detailed enough description of this PR.
 
-## Documentation
-
-If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.
-
-- User docs: <https://github.com/GameServerManagers/LinuxGSM-Docs>
-- Dev docs: <https://github.com/GameServerManagers/LinuxGSM-Dev-Docs>
-
 **Thank you for your Pull Request!**

.github/scripts/details-check-generate-matrix.sh

@@ -1,50 +1,50 @@
 #!/bin/bash
+# Splits the servers to check into shards (one job each) and a list of legacy servers.
+# Legacy servers need an older glibc than the hosted runners have, so they run in an ubuntu:20.04 container.
+# Writes shards.json (matrix) and legacy.txt (space-separated shortnames).
 
 ref="${LGSM_REF:-${GITHUB_REF#refs/heads/}}"
-curl "https://raw.githubusercontent.com/GameServerManagers/LinuxGSM/${ref}/lgsm/data/serverlist.csv" | grep -v '^[[:blank:]]*$' > serverlist.csv
+maxshards="${DETAILS_CHECK_SHARDS:-12}"
+legacyservers="bfv bf1942 btl onset"
 
-echo -n "{" > "shortnamearray.json"
-echo -n "\"include\":[" >> "shortnamearray.json"
+if [ -f lgsm/data/serverlist.csv ]; then
+	serverlist="lgsm/data/serverlist.csv"
+else
+	curl -fsS "https://raw.githubusercontent.com/GameServerManagers/LinuxGSM/${ref}/lgsm/data/serverlist.csv" -o serverlist.csv
+	serverlist="serverlist.csv"
+fi
 
-while read -r line; do
-	shortname=$(echo "$line" | awk -F, '{ print $1 }')
-	# If TARGETED_SHORTNAMES is set, skip servers not in the list
-	if [ -n "${TARGETED_SHORTNAMES:-}" ]; then
-		if ! echo "${TARGETED_SHORTNAMES}" | grep -qw "${shortname}"; then
-			continue
-		fi
+shortnames=()
+legacy=()
+while IFS=, read -r shortname _; do
+	[ -z "${shortname}" ] && continue
+	if [ -n "${TARGETED_SHORTNAMES:-}" ] && ! echo "${TARGETED_SHORTNAMES}" | grep -qw "${shortname}"; then
+		continue
 	fi
-	export shortname
-	servername=$(echo "$line" | awk -F, '{ print $2 }')
-	export servername
-	gamename=$(echo "$line" | awk -F, '{ print $3 }')
-	export gamename
-	distro=$(echo "$line" | awk -F, '{ print $4 }')
-	export distro
-	# Legacy servers that require older Ubuntu/Debian versions due to glibc compatibility
-	case "${shortname}" in
-		bfv | bf1942)
-			# Requires Ubuntu <= 22.04 or Debian <= 12 (glibc 2.31 compatible)
-			runner="ubuntu-22.04"
-			;;
-		btl | onset)
-			# Requires Ubuntu <= 20.04 or Debian <= 11 (glibc 2.31 compatible)
-			runner="ubuntu-20.04"
-			;;
-		*)
-			runner="ubuntu-latest"
-			;;
-	esac
-	{
-		echo -n "{"
-		echo -n "\"shortname\":"
-		echo -n "\"${shortname}\""
-		echo -n ",\"runner\":"
-		echo -n "\"${runner}\""
-		echo -n "},"
-	} >> "shortnamearray.json"
-done < <(tail -n +2 serverlist.csv)
-sed -i '$ s/.$//' "shortnamearray.json"
-echo -n "]" >> "shortnamearray.json"
-echo -n "}" >> "shortnamearray.json"
-rm serverlist.csv
+	if echo "${legacyservers}" | grep -qw "${shortname}"; then
+		legacy+=("${shortname}")
+	else
+		shortnames+=("${shortname}")
+	fi
+done < <(tail -n +2 "${serverlist}" | grep -v '^[[:blank:]]*$')
+
+count="${#shortnames[@]}"
+shards=$((count < maxshards ? count : maxshards))
+declare -a shard
+for i in "${!shortnames[@]}"; do
+	shard[i % shards]+="${shortnames[i]} "
+done
+
+{
+	echo -n '{"include":['
+	for ((i = 0; i < shards; i++)); do
+		[ "${i}" -gt 0 ] && echo -n ','
+		echo -n "{\"shard\":\"$((i + 1))/${shards}\",\"shortnames\":\"${shard[i]% }\"}"
+	done
+	echo -n ']}'
+} > shards.json
+
+echo -n "${legacy[*]}" > legacy.txt
+[ "${serverlist}" == "serverlist.csv" ] && rm serverlist.csv
+
+echo "Servers: ${count} in ${shards} shard(s), legacy: ${legacy[*]:-none}"

.github/scripts/details-check-run.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+# Runs the details check for each shortname given, in one shared LinuxGSM directory.
+# Modules, default configs and data come from the checkout, so the code under test is used and nothing is downloaded per server.
+# Usage: details-check-run.sh <shortname>...
+
+src="${GITHUB_WORKSPACE:-${PWD}}"
+workdir="${DETAILS_CHECK_DIR:-${HOME}/details-check}"
+summary="${GITHUB_STEP_SUMMARY:-/dev/null}"
+export LGSM_GITHUBBRANCH="${LGSM_REF:?LGSM_REF must be set}"
+
+rm -rf "${workdir}"
+mkdir -p "${workdir}/lgsm" "${workdir}/serverfiles"
+cp "${src}/linuxgsm.sh" "${workdir}/"
+cp -r "${src}/lgsm/modules" "${src}/lgsm/config-default" "${src}/lgsm/data" "${workdir}/lgsm/"
+cd "${workdir}" || exit 1
+
+result() {
+	if [ "${1}" -eq 0 ]; then echo "✅ pass"; else echo "❌ fail"; fi
+}
+
+failed=()
+{
+	echo "| Server | Config | Details | Parse game details | Query raw |"
+	echo "|--------|--------|---------|--------------------|-----------|"
+} >> "${summary}"
+
+for shortname in "$@"; do
+	gameserver="${shortname}server"
+	echo "::group::${gameserver}"
+	./linuxgsm.sh "${gameserver}"
+	./"${gameserver}" developer
+
+	servercfg=$(sed -n "/^\<servercfgdefault\>/ { s/.*= *\"\?\([^\"']*\)\"\?/\1/p;q }" "lgsm/config-lgsm/${gameserver}/_default.cfg")
+	if [ -n "${servercfg}" ]; then
+		cfgpath="${servercfg}"
+		[[ "${cfgpath}" == \$\{*\}/* ]] && cfgpath="${cfgpath#*\}/}"
+		curl -fsS -o "config-${shortname}" "https://raw.githubusercontent.com/GameServerManagers/Game-Server-Configs/main/${shortname}/${cfgpath}"
+		config=$?
+		[ "${config}" -eq 0 ] && cat "config-${shortname}"
+		configresult=$(result "${config}")
+	else
+		echo "This game server has no config file."
+		config=0
+		configresult="➖ none"
+	fi
+	grep "startparameters" "lgsm/config-default/config-lgsm/${gameserver}/_default.cfg"
+
+	./"${gameserver}" details
+	details=$?
+	./"${gameserver}" parse-game-details
+	parse=$?
+	./"${gameserver}" query-raw
+	query=$?
+	echo "::endgroup::"
+
+	if [ "${config}" -ne 0 ] || [ "${details}" -ne 0 ] || [ "${parse}" -ne 0 ] || [ "${query}" -ne 0 ]; then
+		failed+=("${gameserver}")
+		echo "::error title=${gameserver}::config=${config} details=${details} parse-game-details=${parse} query-raw=${query}"
+	fi
+	echo "| ${gameserver} | ${configresult} | $(result "${details}") | $(result "${parse}") | $(result "${query}") |" >> "${summary}"
+done
+
+if [ "${#failed[@]}" -gt 0 ]; then
+	echo -e "\n**Failed:** ${failed[*]}" >> "${summary}"
+	exit 1
+fi

.github/workflows/action-add-to-project.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Add to Project
-        uses: actions/add-to-project@v1.0.2
+        uses: actions/add-to-project@v2.0.0
         with:
           project-url: https://github.com/orgs/GameServerManagers/projects/11
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}