Post-release phase - Revision history

Thoun at 10:08, 20 April 2026

2026-04-20T10:08:58Z

← Older revision		Revision as of 12:08, 20 April 2026
Line 110:		Line 110:
	* check the database to see if your changes have been correctly applied.		* check the database to see if your changes have been correctly applied.

	Note4: consider that if your game has some undo support capability through 'db_undo_support~~' =>~~ true,' in the gameinfos.~~inc.php~~, calling the undoRestorePoint() could restore to a prior game version and the upgradeTableDb() could be called again. In that case, it's better to secure the SQL Alter Table Request with something like:		Note4: consider that if your game has some undo support capability through "db_undo_support": true, in the gameinfos.jsonc, calling the undoRestorePoint() could restore to a prior game version and the upgradeTableDb() could be called again. In that case, it's better to secure the SQL Alter Table Request with something like:
	function upgradeTableDb( $from_version ){		function upgradeTableDb( $from_version ){
	if( $from_version <= YYMMDDHHMM )		if( $from_version <= YYMMDDHHMM )

BaronFraser: Added a "Documentation for Bug Reports" section as I can never remember how to do this (not sure it's documented except in Discord)

2026-01-09T01:05:08Z

Added a "Documentation for Bug Reports" section as I can never remember how to do this (not sure it's documented except in Discord)

← Older revision		Revision as of 03:05, 9 January 2026
Line 12:		Line 12:

	During days after your game has been published and from time to time, please have a look at it to check if everything is fine.		During days after your game has been published and from time to time, please have a look at it to check if everything is fine.

			== Documentation for Bug Reports ==
			You can provide a wiki page for the attention of bug reporters.

			To edit the page for your game, go to https://www.boardgamearena.com/bugs and click "Create a new report". Choose "About a game..." and then enter a table number where your game has been played, '''then tab away from the game number text box''' (important!).

			You will be presented with an "Edit bug clarifications Wiki page" button, where you can edit the page.

			When players who are not admins follow the same procedure, instead of being offered an "Edit bug clarifications Wiki page" button, they will be offered a "Make sure to read the game specific bug clarifications" link. To be fair, most of them won't follow it, but it may help reduce the number of reports you keep getting from players who don't understand the rules, and it does offer a page you can refer players back to when they do.

	== How to submit changes? ==		== How to submit changes? ==

Victoria La: /* Updating game options */

2023-10-13T01:06:10Z

Updating game options

← Older revision		Revision as of 03:06, 13 October 2023
Line 55:		Line 55:

	* If you add options, you should let us know which value should be used for the arena mode, so that we can update the arena configuration.		* If you add options, you should let us know which value should be used for the arena mode, so that we can update the arena configuration.
	* If you remove an option or change a ~~version~~ ID, it will break the arena configuration and prevent creating new arena games, so you should let us know so that we can synchronize to update the configuration at the same time as you deploy the new version.		* If you remove an option or change a option ID, it will break the arena configuration and prevent creating new arena games, so you should let us know so that we can synchronize to update the configuration at the same time as you deploy the new version.
	* Do not change option IDs once the game is in production, it will break ongoing games and audience option statistics.		* Do not change option IDs once the game is in production, it will break ongoing games and audience option statistics.

Victoria La: /* How to submit changes? */

2023-10-13T00:56:55Z

How to submit changes?

@@ Line 15: / Line 15: @@
 == How to submit changes? ==
-There is 3 (short) steps to make your changes visible on BGA (from your Control Panel):
+There are steps to make your changes visible on BGA (from your game Control Panel, i.e. https://studio.boardgamearena.com/studiogame?game=mygamename):
 == What can be modified after release? ==

Quietmint: /* Avoiding version mismatches */

2023-09-17T15:57:32Z

Avoiding version mismatches

← Older revision		Revision as of 17:57, 17 September 2023
Line 133:		Line 133:
	Be advised about the timing of deployments: Your new PHP backend code takes effect '''immediately''', but your new JS/HTML/CSS frontend code does not take effect unless current players reload the page (F5). This can lead to unexpected behavior and difficult-to-reproduce bugs caused by old JS client code interacting with new PHP server code.		Be advised about the timing of deployments: Your new PHP backend code takes effect '''immediately''', but your new JS/HTML/CSS frontend code does not take effect unless current players reload the page (F5). This can lead to unexpected behavior and difficult-to-reproduce bugs caused by old JS client code interacting with new PHP server code.

	Until the BGA framework handles this automatically for everyone, your game should definitely implement something like [[BGA Studio Cookbook#Force players to refresh after new deploy]].		Until the BGA framework handles this automatically for everyone (please upvote https://studio.boardgamearena.com/bug?id=106), your game should definitely implement something like [[BGA Studio Cookbook#Force players to refresh after new deploy]].
	[[Category:Studio]]		[[Category:Studio]]

Quietmint at 15:25, 17 September 2023

2023-09-17T15:25:38Z

← Older revision		Revision as of 17:25, 17 September 2023
Line 20:		Line 20:
	* Build a new version (don't forget to do a successful commit BEFORE your build).		* Build a new version (don't forget to do a successful commit BEFORE your build).
	* Deploy your new version in production.		* Deploy your new version in production.


	== What can be modified after release? ==		== What can be modified after release? ==

Line 63:		Line 61:

	function upgradeTableDb( $from_version ){		function upgradeTableDb( $from_version ){
			<nowiki> </nowiki>
	if( $from_version <= YYMMDDHHMM ){ // where your CURRENT version in production has number YYMMDD-HHMM		<nowiki> </nowiki>if( $from_version <= YYMMDDHHMM ){ // where your CURRENT version in production has number YYMMDD-HHMM
			<nowiki> </nowiki>
	// You DB schema update request.		<nowiki> </nowiki> // You DB schema update request.
	// Note: all tables names should be prefixed by "DBPREFIX_" to be compatible with the applyDbUpgradeToAllDB method you should use below		<nowiki> </nowiki> // Note: all tables names should be prefixed by "DBPREFIX_" to be compatible with the applyDbUpgradeToAllDB method you should use below
	$sql = "CREATE TABLE DBPREFIX_xxxxxxx ....";		<nowiki> </nowiki> $sql = "CREATE TABLE DBPREFIX_xxxxxxx ....";
			<nowiki> </nowiki>
	// The method below is applying your DB schema update request to all tables, including the BGA framework utility tables like "zz_replayXXXX" or "zz_savepointXXXX".		<nowiki> </nowiki> // The method below is applying your DB schema update request to all tables, including the BGA framework utility tables like "zz_replayXXXX" or "zz_savepointXXXX".
	// You should really use this request, in conjunction with "DBPREFIX_" in your $sql, so ALL tables are updated. All utility tables MUST have the same schema than the main table, otherwise the game may be blocked.		<nowiki> </nowiki> // You should really use this request, in conjunction with "DBPREFIX_" in your $sql, so ALL tables are updated. All utility tables MUST have the same schema than the main table, otherwise the game may be blocked.
	self::applyDbUpgradeToAllDB( $sql );		<nowiki> </nowiki> self::applyDbUpgradeToAllDB( $sql );
	}}		<nowiki> </nowiki>}}

	Note1: of course you need to change your dbmodel.sql accordingly, so that new games get your updated scheme.		Note1: of course you need to change your dbmodel.sql accordingly, so that new games get your updated scheme.
Line 91:		Line 89:
	* check the database to see if your changes have been correctly applied.		* check the database to see if your changes have been correctly applied.

	Note4: consider that if your game has some undo support capability through 'db_undo_support' => true,' in the gameinfos.inc.php, calling the undoRestorePoint() could restore to a prior game version and the upgradeTableDb() could be called again. In that case, it's better to secure the SQL Alter Table Request with something like :		Note4: consider that if your game has some undo support capability through 'db_undo_support' => true,' in the gameinfos.inc.php, calling the undoRestorePoint() could restore to a prior game version and the upgradeTableDb() could be called again. In that case, it's better to secure the SQL Alter Table Request with something like:
	function upgradeTableDb( $from_version ){		function upgradeTableDb( $from_version ){
	if( $from_version <= YYMMDDHHMM )		if( $from_version <= YYMMDDHHMM )
Line 102:		Line 100:
	}		}
	}		}

	Note5: Due to [https://studio.boardgamearena.com/bug?id=64 bug #64 (opened 2021-11-20)], BGA can generate invalid SQL when you use "DBPREFIX_"! When this happens, an exception is thrown and it will be impossible to load the table in production (it will show a white "unexpected error" page). Until this bug is fixed, use something like this to retry any failing SQL without "DBPREFIX_":

	~~function upgradeTableDb($from_version)~~
	{
	~~$changes = [~~
	~~[2209030117, "ALTER TABLE DBPREFIX_player ADD `attempts` INT NOT NULL DEFAULT 0"],~~
	[2209030117, "UPDATE DBPREFIX_player SET `attempts` = (SELECT `global_value` FROM DBPREFIX_global WHERE `global_id` = 40) WHERE `player_id` = (SELECT `global_value` FROM DBPREFIX_global WHERE `global_id` = 2)"],
	~~[2209030442, "INSERT INTO DBPREFIX_global (`global_id`, `global_value`) VALUES (171, 1)"],~~
	];
	~~foreach ($changes as [$version, $sql]) {~~
	~~if ($from_version <= $version) {~~
	~~try {~~
	~~self::warn("upgradeTableDb apply 1: from_version=$from_version, change=[ $version, $sql ]");~~
	~~self::applyDbUpgradeToAllDB($sql);~~
	~~} catch (Exception $e) {~~
	~~// See https://studio.boardgamearena.com/bug?id=64~~
	~~// BGA framework can produce invalid SQL with non-existant tables when using DBPREFIX_.~~
	~~// The workaround is to retry the query on the base table only.~~
	~~self::error("upgradeTableDb apply 1 failed: from_version=$from_version, change=[ $version, $sql ]");~~
	~~$sql = str_replace("DBPREFIX_", "", $sql);~~
	~~self::warn("upgradeTableDb apply 2: from_version=$from_version, change=[ $version, $sql ]");~~
	~~self::applyDbUpgradeToAllDB($sql);~~
	}
	}
	}
	~~self::warn("upgradeTableDb complete: from_version=$from_version");~~
	}

	=== Updating string to be translated ===		=== Updating string to be translated ===
Line 150:		Line 120:
	See for example Werewolves group:		See for example Werewolves group:
	https://boardgamearena.com/group?id=2465913		https://boardgamearena.com/group?id=2465913


	===Major changes===		===Major changes===

Line 162:		Line 130:
	* And eventually, publish a news about it :)		* And eventually, publish a news about it :)

			== Avoiding version mismatches ==
			Be advised about the timing of deployments: Your new PHP backend code takes effect '''immediately''', but your new JS/HTML/CSS frontend code does not take effect unless current players reload the page (F5). This can lead to unexpected behavior and difficult-to-reproduce bugs caused by old JS client code interacting with new PHP server code.

			Until the BGA framework handles this automatically for everyone, your game should definitely implement something like [[BGA Studio Cookbook#Force players to refresh after new deploy]].
	[[Category:Studio]]		[[Category:Studio]]

Quietmint: /* Updating the database schema */

2022-09-14T01:44:58Z

Updating the database schema

← Older revision		Revision as of 03:44, 14 September 2022
Line 108:		Line 108:
	{		{
	$changes = [		$changes = [
	2209030117 => "ALTER TABLE DBPREFIX_player ADD `attempts` INT NOT NULL DEFAULT 0",		[2209030117, "ALTER TABLE DBPREFIX_player ADD `attempts` INT NOT NULL DEFAULT 0"],
	2209030117 => "UPDATE DBPREFIX_player SET `attempts` = (SELECT `global_value` FROM DBPREFIX_global WHERE `global_id` = 40) WHERE `player_id` = (SELECT `global_value` FROM DBPREFIX_global WHERE `global_id` = 2)",		[2209030117, "UPDATE DBPREFIX_player SET `attempts` = (SELECT `global_value` FROM DBPREFIX_global WHERE `global_id` = 40) WHERE `player_id` = (SELECT `global_value` FROM DBPREFIX_global WHERE `global_id` = 2)"],
	2209030442 => "INSERT INTO DBPREFIX_global (`global_id`, `global_value`) VALUES (171, 1)",		[2209030442, "INSERT INTO DBPREFIX_global (`global_id`, `global_value`) VALUES (171, 1)"],
	];		];
	foreach ($changes as $version => $sql) {		foreach ($changes as [$version, $sql]) {
	if ($from_version <= $version) {		if ($from_version <= $version) {
	try {		try {

Quietmint: /* Updating the database schema */

2022-09-05T13:54:51Z

Updating the database schema

← Older revision		Revision as of 15:54, 5 September 2022
Line 128:		Line 128:
	}		}
	}		}
			self::warn("upgradeTableDb complete: from_version=$from_version");
	}		}

Quietmint: /* Updating the database schema */

2022-09-05T13:44:40Z

Updating the database schema

@@ Line 102: / Line 102: @@
+          }
+        }
 === Updating string to be translated  ===

Victoria La at 23:27, 16 May 2022

2022-05-16T23:27:23Z

← Older revision		Revision as of 01:27, 17 May 2022
Line 133:		Line 133:
	* Make your game back from "gold" to "public beta", to incite player to report bugs.		* Make your game back from "gold" to "public beta", to incite player to report bugs.
	* And eventually, publish a news about it :)		* And eventually, publish a news about it :)

			[[Category:Studio]]