@@ -1317,6 +1317,49 @@ <h2 id="docs.5.1">5.1. Development Workflow Set Up</h2>
13171317 should receive < code class ="inline "> IMPORT STATUS: OK</ code > and
13181318 < code class ="inline "> EXPORT STATUS: OK</ code > messages.
13191319 </ p >
1320+ < p >
1321+ The workflow to release a new version of WebTerminal is presented below.
1322+ Please, be very careful when releasing new versions, as all the WebTerminal
1323+ users will start receiving updates. To release a new WebTerminal version, do the following:
1324+ </ p >
1325+ < ol >
1326+ < li >
1327+ Build and carefully test the project as described above.
1328+ </ li >
1329+ < li >
1330+ Copy < code class ="inline "> build/WebTerminal-vX.Y.Z.xml</ code > file to the
1331+ < code class ="inline "> docs/files</ code > directory.
1332+ </ li >
1333+ < li >
1334+ Append a record describing changes to < code class ="inline "> docs/terminal.json</ code > file.
1335+ You can accurately copy-paste-edit records from the previous records. Make sure you changed
1336+ the < code class ="inline "> /versions/X/v</ code > and < code class ="inline "> /versions/X/url</ code >
1337+ to the latest version and the location of the file respectively. Note that the latest version
1338+ bust be < b > greater</ b > than the previous version. Make sure that the JSON structure is still
1339+ valid.
1340+ </ li >
1341+ < li >
1342+ If the change is pretty important, add it to visible releases by editing
1343+ < code class ="inline "> docs/index.html</ code > file.
1344+ </ li >
1345+ < li >
1346+ After you push these changes to repository, test whether terminal receives the new version and
1347+ properly updates.
1348+ </ li >
1349+ </ ol >
1350+ < p >
1351+ A special care must be taken while altering WebTerminal < b > updating mechanism</ b >
1352+ (< code class ="inline "> WebTerminal.Updater</ code > class). If you push a broken change, WebTerminal
1353+ will update itself normally, but possibly only for the first time. For the next updates WebTerminal
1354+ will use the new update code which can make it never update again (user will need to reinstall it manually).
1355+ </ p >
1356+ < p >
1357+ You can put the < code class ="inline "> /motd</ code > (message of the day) message to
1358+ < code class ="inline "> docs/terminal.json</ code > : all WebTerminal users will start to see this
1359+ message in console. Do it < b > only when absolute necessary</ b > : do not distract users. This functionality
1360+ is kept for the critical WebTerminal update faults: when users will need to reinstall WebTerminal
1361+ manually (hopefully never).
1362+ </ p >
13201363 < h2 id ="docs.5.2 "> 5.2. Guidelines</ h2 >
13211364 < p >
13221365 There are several guidelines you should consider if you want to contribute to
@@ -1828,4 +1871,4 @@ <h1>Caché WEB Terminal v2 Beta Release</h1>
18281871 </ a >
18291872 </ body >
18301873
1831- </ html >
1874+ </ html >
0 commit comments