Releasing.wiki
author Wuzzy
Fri, 31 May 2019 19:12:26 +0100
changeset 1912 94899e4fabe6
parent 1701 b131247a8f29
child 1953 3074bfed69bd
permissions -rw-r--r--
GearTypes: Warnings about gtATStartGame and gtATFinishGame
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
     1
#summary How releases are done in Hedgewars
1662
a59c733832f5 Releasing: fix typo
Wuzzy
parents: 1623
diff changeset
     2
= Releasing Hedgewars =
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
     3
This page is a checklist of things to do in order to do a proper Hedgewars release.
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
1279
6ea7b43554b8 Releasing: fix syntax
Wuzzy
parents: 1278
diff changeset
     5
== Getting ready for release ==
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
1281
9b9e721189b8 Releasing: move string freeze to the top
Wuzzy
parents: 1280
diff changeset
     7
 * Try to announce string freeze in News a few weeks before the planned release to give translators a fair chance
1623
d5a96c14bec1 Releasing: Link protocol number
Wuzzy
parents: 1622
diff changeset
     8
 * Bump [ProtocolNumbers protocol number]
1665
244fd94698f2 Releasing: Refer to concrete files
Wuzzy
parents: 1662
diff changeset
     9
     * `HEDGEWARS_PROTO_VER` in `CMakeLists.txt`
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
 * Bump Hedgewars version number (if it hasn't already)
1293
c4f6ed01dd62 Releasing: Edited via web interface
unC0Rr
parents: 1288
diff changeset
    11
 * Update server sources
c4f6ed01dd62 Releasing: Edited via web interface
unC0Rr
parents: 1288
diff changeset
    12
     * Update newest version
1665
244fd94698f2 Releasing: Refer to concrete files
Wuzzy
parents: 1662
diff changeset
    13
     * Make server aware of new version and new -dev version protocol numbers (`protoNumber2ver` in `gameServer/Utils.hs`)
244fd94698f2 Releasing: Refer to concrete files
Wuzzy
parents: 1662
diff changeset
    14
     * Update MOTD to reflect version changes (`newServerInfo` in `gameServer/CoreTypes.hs`)
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    15
 * Update `ChangeLog.txt`
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
 * Update all translation strings
1489
a11478019ccf Releasing: update translation update
Wuzzy
parents: 1479
diff changeset
    17
     * For frontend (.ts) and Lua (.lua): Run `tools/update_locale_files.sh` and grab a coffee
a11478019ccf Releasing: update translation update
Wuzzy
parents: 1479
diff changeset
    18
     * Other files might need manual updating
1295
42dce375d82a Releasing: rewrite tourney stuff
Wuzzy
parents: 1294
diff changeset
    19
 * If there was a Shoppa tournament after the previous release: Update prizes
42dce375d82a Releasing: rewrite tourney stuff
Wuzzy
parents: 1294
diff changeset
    20
     * Put the names of the top 3 players on the plaques in _ShoppaKing_ and _TrophyRace_
42dce375d82a Releasing: rewrite tourney stuff
Wuzzy
parents: 1294
diff changeset
    21
     * Add the names of (at least) the top 3 players in the pool of random names in _Rope-Knocking Challenge_
1528
7a22fe21b51e Releasing: Add system requirements to checklist
Wuzzy
parents: 1489
diff changeset
    22
 * Update system requirements, if neccessary:
7a22fe21b51e Releasing: Add system requirements to checklist
Wuzzy
parents: 1489
diff changeset
    23
     * 1) In the `README.md` file
7a22fe21b51e Releasing: Add system requirements to checklist
Wuzzy
parents: 1489
diff changeset
    24
     * 2) In the Hedgewars homepage: https://hedgewars.org/node/6977
1281
9b9e721189b8 Releasing: move string freeze to the top
Wuzzy
parents: 1280
diff changeset
    25
1279
6ea7b43554b8 Releasing: fix syntax
Wuzzy
parents: 1278
diff changeset
    26
== Releasing ==
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    27
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    28
 * Add a tag for the relevant commit
1622
b495f8dc4308 Releasing: Remove some blabla
Wuzzy
parents: 1528
diff changeset
    29
 * Create a Windows build
1294
825173931441 Releasing: add torrents
Wuzzy
parents: 1293
diff changeset
    30
 * Create torrents
1298
093dbedcb57a Releasing: release archive
Wuzzy
parents: 1297
diff changeset
    31
 * Update [https://hedgewars.org/release-archive release archive]
1287
58a3fa42799c Releasing: fix syntax
Wuzzy
parents: 1286
diff changeset
    32
 * Update [https://hedgewars.org/download.html Download page]
1286
845ed0f307de Releasing: moar links
Wuzzy
parents: 1285
diff changeset
    33
 * Announce release on News section on [https://hedgewars.org/ www.hedgewars.org]
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    34
 * Announce release in IRC (`#hedgewars`)
1622
b495f8dc4308 Releasing: Remove some blabla
Wuzzy
parents: 1528
diff changeset
    35
 * Announce release in official server
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    36
     * Update protocol number
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    37
     * Update MOTD
1285
3a6140bc26f5 Releasing: server rights fix
Wuzzy
parents: 1284
diff changeset
    38
     * In lobby, use command `/global Hedgewars X.Y.Z has just been released!`
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    39
1322
5a23bf55175c Releasing: fix header
Wuzzy
parents: 1321
diff changeset
    40
== Post-release ==
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    41
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    42
 * Notify package managers of GNU/Linux distributions
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    43
 * Update Hedgewars Wiki
1323
0c3daa656c67 Releasing: fix Lua9 typo
Wuzzy
parents: 1322
diff changeset
    44
 * Update HWKB (esp. because of Lua)
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    45
 * Update game info on online game databases, if you have access
1479
9d707ee4660f Releasing: Mention bugzilla
Wuzzy
parents: 1323
diff changeset
    46
 * Add new version to Bugzilla
1701
b131247a8f29 Releasing: Screenshots / trailer
Wuzzy
parents: 1665
diff changeset
    47
 * Optional: Add a couple of nice screenshots
b131247a8f29 Releasing: Screenshots / trailer
Wuzzy
parents: 1665
diff changeset
    48
 * Optional: Make a trailer
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    49
 
1279
6ea7b43554b8 Releasing: fix syntax
Wuzzy
parents: 1278
diff changeset
    50
== For release candidates ==
1288
c24eea5df7e4 Releasing: grammar
Wuzzy
parents: 1287
diff changeset
    51
Release candidates may be released before the actual release for testing. They might be combined with a string freeze.
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    52
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    53
 * Create a Windows build
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    54
 * Remember the commit ID to which the release canditate refers to
1286
845ed0f307de Releasing: moar links
Wuzzy
parents: 1285
diff changeset
    55
 * Write a post in News, you can use this post as a template: [https://hedgewars.org/node/6907]