Releasing.wiki
author Wuzzy
Sat, 07 Dec 2019 11:23:22 +0000
changeset 2123 7df4304efaef
parent 2091 428ad3d1d034
permissions -rw-r--r--
LuaGears: Explain heResurrected better
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
2008
b97b65082ea5 Releasing: Add common pitfalls
Wuzzy
parents: 2005
diff changeset
     7
 * Fix common pitfalls
2010
57c2f6d13d19 Releasing: Edited via web interface
Wuzzy
parents: 2009
diff changeset
     8
     * Make sure all `*.pas` files are ASCII only
2008
b97b65082ea5 Releasing: Add common pitfalls
Wuzzy
parents: 2005
diff changeset
     9
     * Test Pas2C, fix anything that's broken
2080
870bd5e04865 Releasing: mention racer.yaml
Wuzzy
parents: 2053
diff changeset
    10
 * If new weapons have been added:
870bd5e04865 Releasing: mention racer.yaml
Wuzzy
parents: 2053
diff changeset
    11
     * Test if new weapon can be selected in frontend, online play, local play
870bd5e04865 Releasing: mention racer.yaml
Wuzzy
parents: 2053
diff changeset
    12
     * Test if new weapon can be saved properly in ammo scheme
2081
a0c2ba8d636a Releasing: Edited via web interface
Wuzzy
parents: 2080
diff changeset
    13
     * Update `AMMO` in [https://hedgewars.org/kb/RacerRoomSetup the Official Racer room config file]
2091
428ad3d1d034 Releasing: Add Big Armory
Wuzzy
parents: 2081
diff changeset
    14
     * Update preview image of Big Armory mission
1281
9b9e721189b8 Releasing: move string freeze to the top
Wuzzy
parents: 1280
diff changeset
    15
 * 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
    16
 * Bump [ProtocolNumbers protocol number]
1665
244fd94698f2 Releasing: Refer to concrete files
Wuzzy
parents: 1662
diff changeset
    17
     * `HEDGEWARS_PROTO_VER` in `CMakeLists.txt`
1995
a920dd125ae8 Releasing: Mention wiki
Wuzzy
parents: 1953
diff changeset
    18
     * Wiki page: [ProtocolNumbers]
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    19
 * Bump Hedgewars version number (if it hasn't already)
1293
c4f6ed01dd62 Releasing: Edited via web interface
unC0Rr
parents: 1288
diff changeset
    20
 * Update server sources
c4f6ed01dd62 Releasing: Edited via web interface
unC0Rr
parents: 1288
diff changeset
    21
     * Update newest version
1665
244fd94698f2 Releasing: Refer to concrete files
Wuzzy
parents: 1662
diff changeset
    22
     * 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
    23
     * 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
    24
 * Update `ChangeLog.txt`
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    25
 * Update all translation strings
1489
a11478019ccf Releasing: update translation update
Wuzzy
parents: 1479
diff changeset
    26
     * 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
    27
     * Other files might need manual updating
1295
42dce375d82a Releasing: rewrite tourney stuff
Wuzzy
parents: 1294
diff changeset
    28
 * If there was a Shoppa tournament after the previous release: Update prizes
42dce375d82a Releasing: rewrite tourney stuff
Wuzzy
parents: 1294
diff changeset
    29
     * 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
    30
     * 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
    31
 * Update system requirements, if neccessary:
7a22fe21b51e Releasing: Add system requirements to checklist
Wuzzy
parents: 1489
diff changeset
    32
     * 1) In the `README.md` file
7a22fe21b51e Releasing: Add system requirements to checklist
Wuzzy
parents: 1489
diff changeset
    33
     * 2) In the Hedgewars homepage: https://hedgewars.org/node/6977
1281
9b9e721189b8 Releasing: move string freeze to the top
Wuzzy
parents: 1280
diff changeset
    34
1279
6ea7b43554b8 Releasing: fix syntax
Wuzzy
parents: 1278
diff changeset
    35
== Releasing ==
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    36
2005
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    37
 # Purge your repository: `hg purge --all` (needs `purge` extension). Warning: This resets ALL the files, make sure to backup whatever you need
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    38
 # Create a source tarball (`.tar.bz2`). Run `make package_source`
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    39
 # Create a Windows build
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    40
 # Create a macOS build, if possible
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    41
 # Test the builds
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    42
 # Create torrents
2009
fb92d64fe9b8 Releasing: Add branch todo
Wuzzy
parents: 2008
diff changeset
    43
 # Add a tag for the relevant commit (name: `<version>-release`) (*after* the builds have succeeded!)
fb92d64fe9b8 Releasing: Add branch todo
Wuzzy
parents: 2008
diff changeset
    44
 # Start a branch with the name `<version>` (e.g. 1.0.0), on the commit you tagged
2053
ecb23da6ab1f Releasing: Edited via web interface
unC0Rr
parents: 2052
diff changeset
    45
 # Update symlink for windows installer `download/releases/hedgewars-win32.exe` to point to the latest release installer
2005
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    46
 # Update [https://hedgewars.org/release-archive release archive]
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    47
 # Update [https://hedgewars.org/download.html Download page]
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    48
 # Announce release on News section on [https://hedgewars.org/ www.hedgewars.org]
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    49
 # Announce release in IRC (`#hedgewars`)
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    50
 # Announce release in official server
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    51
     # Update protocol number
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    52
     # Update MOTD
017b57b75854 Releasing: Numbered list
Wuzzy
parents: 2002
diff changeset
    53
     # In lobby, use command `/global Hedgewars X.Y.Z has just been released!`
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    54
1322
5a23bf55175c Releasing: fix header
Wuzzy
parents: 1321
diff changeset
    55
== Post-release ==
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    56
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    57
 * Notify package managers of GNU/Linux distributions
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    58
 * Update Hedgewars Wiki
1323
0c3daa656c67 Releasing: fix Lua9 typo
Wuzzy
parents: 1322
diff changeset
    59
 * Update HWKB (esp. because of Lua)
1321
e5905fadfab6 Releasing: update wiki
Wuzzy
parents: 1298
diff changeset
    60
 * Update game info on online game databases, if you have access
1479
9d707ee4660f Releasing: Mention bugzilla
Wuzzy
parents: 1323
diff changeset
    61
 * Add new version to Bugzilla
1701
b131247a8f29 Releasing: Screenshots / trailer
Wuzzy
parents: 1665
diff changeset
    62
 * Optional: Add a couple of nice screenshots
b131247a8f29 Releasing: Screenshots / trailer
Wuzzy
parents: 1665
diff changeset
    63
 * Optional: Make a trailer
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    64
 
1279
6ea7b43554b8 Releasing: fix syntax
Wuzzy
parents: 1278
diff changeset
    65
== For release candidates ==
1288
c24eea5df7e4 Releasing: grammar
Wuzzy
parents: 1287
diff changeset
    66
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
    67
2011
1c2ca44d7b46 Releasing: Add source to RC checklist
Wuzzy
parents: 2010
diff changeset
    68
 * Create a source tarball (see above)
1278
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    69
 * Create a Windows build
1cc36d9f1394 Add page explaining how to release Hedgewars
Wuzzy <almikes@aol.com>
parents:
diff changeset
    70
 * Remember the commit ID to which the release canditate refers to
1286
845ed0f307de Releasing: moar links
Wuzzy
parents: 1285
diff changeset
    71
 * Write a post in News, you can use this post as a template: [https://hedgewars.org/node/6907]