How to release Tera Term installation package

Start release operation

Confirm ticket and branches.

Confirm in project team.
- Organize / decide whether to include bug fix / feature in this release or defer.
Merge branches
- Merge working branches into main branch.
- Cherry-pick the commits from working branches into merge-to-stable branch, and then merge into stable branch.
Close issues.
- Close fixed or responded issues.
- Change the milestone for issues which is planned respond in the next release.
Decide respond or postpone about new issue.

Confirm tools, libraries, import sources.

Visual Studio (https://visualstudio.microsoft.com/)
Inno Setup (https://jrsoftware.org/isdl.php)
Oniguruma (https://github.com/kkos/oniguruma/)
SFMT (https://www.math.sci.hiroshima-u.ac.jp/m-mat/MT/SFMT/index.html)
LibreSSL (https://www.libressl.org/)
zlib (https://www.zlib.net/)
The reference C implementation of Argon2 (https://github.com/P-H-C/phc-winner-argon2/)
cJSON (https://github.com/DaveGamble/cJSON/)
Unicode (https://www.unicode.org/versions/latest/)

We use CI tool for release build. For this reason, the detailed version of Visual Studio is uncontrollable. The detailed version will depend on what version is currently adopted by the CI tool at build time.

Library versions are mostly determined at this timing.

In a stable release, library versions are not updated from periodic release. (However, if a library has a security fix, we will handle it on a case-by-case basis.)

What change is included in this release of not included is mostly determined.

Create RC, and aftet that

Create a branch for RC work. (from main branch or stable branch)

git switch main
git pull --rebase
git checkout -b release/5_6_0-RC

Confirm documents.

Check for missing parts of documents. Configuration item on dialog, special options without UI, command line parameters, new macro command and so on.
Check for translations of changed documents. Translate them if they are not translated.
Check for changelog. Add it if found missing. Also make the wording and format consistent.
e.g. A commit to clean up the changelog
Change order of changelog.
Important changes will be located at upper position. Order is terminal emulation, application and macro.
e.g. A commit that reorders the changelog

Increment the year of last publication of copyright notice if it is first release in this year.

teraterm\keycode\keycode-version.rc // VERSIONINFO
teraterm\teraterm\tt-version.rc // VERSIONINFO
teraterm\ttpcmn\ttpcmn-version.rc // VERSIONINFO
teraterm\ttpdlg\ttpdlg.rc // dialog
teraterm\ttpmacro\ttm-version.rc // VERSIONINFO
ttssh2\ttxssh\ttxssh.rc // dialog
ttssh2\ttxssh\ttxssh-version.rc // VERSIONINFO
ttpmenu\ttpmenu.rc // dialog, VERSIONINFO
TTProxy\TTProxy.rc // dialog, VERSIONINFO(en), VERSIONINFO(ja)
TTXKanjiMenu\ttxkanjimenu.rc // VERSIONINFO
installer\teraterm.iss
installer\release\license.txt // Tera Term, TTSSH, Cygterm+, TTProxy, TeraTerm Menu, TTX KanjiMenu
installer\release\license.txt // This file is a version of license.txt without line breaks. Edit it as a plain text file.
doc\en\html\index.html
doc\en\html\about\copyright.html // Tera Term, TTSSH, Cygterm+, TTProxy, TeraTerm Menu, TTX KanjiMenu
doc\en\html\macro\index.html
doc\ja\html\index.html
doc\ja\html\about\copyright.html // Tera Term, TTSSH, Cygterm+, TTProxy, TeraTerm Menu, TTX KanjiMenu
doc\ja\html\macro\index.html

e.g. A commit to clean up the changelog

Increment the version while RC release process.

teraterm\common\tt-version.h
set TT_VERSION_SUBSTR to "RC".

  #define TT_VERSION_MAJOR             5
  #define TT_VERSION_MINOR             6
  #define TT_VERSION_PATCH             0
- #define TT_VERSION_SUBSTR            "dev"
+ #define TT_VERSION_SUBSTR            "RC"
  //#undef TT_VERSION_SUBSTR

TT_VERSION_MINOR or TT_VERSION_PATCH is already incremented yet. It is incremented immediately after previous release.

ttssh2\ttxssh\ttxssh-version.h
TTSSH_VERSION_MINOR or TTSSH_VERSION_PATCH is already incremented yet. It is incremented immediately after previous release.
ttpmenu\ttpmenu-version.h // only modifying
TTProxy\TTProxy.rc // only modifying
TTXKanjiMenu\ttxkanjimenu.h // only modifying

e.g. A commit to increment the version

Create installer. (for check)

Test run installer, run and connect in all supported OS.

Commit and push.

Create the Pull Request to merge working branch.

Merge the Pull Request. (into main branch or stable branch)

A build workflow runs on GitHub Actions.
Three builds are triggered on:

Push to the working branch
Pull Request creation
Merge commit into the main branch or stable branch.

e.g. build 1, 2, 3
The build binary generated from the merge commit is considered the release candidate artifact.

Announce RC release.

X (https://x.com/Tera_Term)
Direct users to report problems via Issues on GitHub, as described here.
Mention that users must be logged in to GitHub to download GitHub Actions artifacts.
e.g. 5.6.0 RC

Delete a working branch.

Get feedbacks.
If changed source code, redo "Confirm documents" and "Test run and connect in all supported OS."

If you are going to release RC2, repeat the steps in this section starting from creating a working branch.

Release

Prepare an announcement texts.

For GitHub Releases
Write summary of release note (in Japanese and English) from changelog of document.
Select a few items that have a major impact on users.
e.g. 5.6.0
For an annoucement on X
Summarize it in 140 characters. (only in Japanese)
e.g. 5.6.0

Create a branch for release work. (from main branch or stable branch)

git switch main
git pull --rebase
git checkout -b release/5_6_0

Confirm documents. (same as above)

Modify release date and remove "RC" string. (Replace it with a commented-out "dev".)

html/about/history.html

teraterm\common\tt-version.h

  #define TT_VERSION_MAJOR             5
  #define TT_VERSION_MINOR             6
  #define TT_VERSION_PATCH             0
- #define TT_VERSION_SUBSTR            "RC"
- //#undef TT_VERSION_SUBSTR
+ //#define TT_VERSION_SUBSTR            "dev"
+ #undef TT_VERSION_SUBSTR

e.g. A commit to change the release date and remove "RC."

Create installer. (for check)

Check that build and installer generation without error.

Push. *

Create the Pull Request to merge working branch. *

Merge the Pull Request. (into main branch or stable branch) *

Create a tag and push. *

Use annotated tags. The naming rule is `v(version)' (e.g. v5.6.0).

git switch main
git pull --rebase
git tag -a v5.4.0 -m "Release 5.4.0"
git push origin v5.4.0

A build workflow runs on GitHub Actions.
Four builds are triggered on:

Push to the working branch
Pull Request creation
Merge commit ito the main branch or stable branch
Tag creation.

e.g. build 1, 2, 3, 4
The build binary generated from the release tag is considered the release artifact.
During the release process, the workflow sends code signing requests to SignPath. SignPath's release-signing policy requires manual approval. Therefore, the workflow will wait until the code signing is approved. To approve the requests, log in to SignPath.io and approve signing requests.

Delete a working branch.

Add to GitHub "Releases."

select a new tag.
put installer and portable zip file and hash file.
write summary of release note.

Check anti-virus software

download by Chrome
download by Edge
Edge has "Defender SmartScreen", it notices "Uncommonly downloaded." Report it as incorrectly detected.

Update project web page (https://teratermproject.github.io).

Please refer to the "How to update project home page" page (in Japanese) in the wiki for update instructions.

Announce release.

X (https://x.com/Tera_Term)
- Post the announcement.
- Pin that post.

Create stable branch and push (only for periodic releases).

git switch main
git pull --rebase
git checkout -b stable_5_6
git push -u origin stable_5_6

Increment the version for text release

When periodic release,

Fix the main branch.

git switch main
git pull --rebase
git checkout -b release/unfroze

teraterm/common/tt-version.h
Increment TT_VERSION_MINOR and set SUBSTR to "dev."

  #define TT_VERSION_MAJOR             5
- #define TT_VERSION_MINOR             6
+ #define TT_VERSION_MINOR             7
  #define TT_VERSION_PATCH             0
- //#define TT_VERSION_SUBSTR            "dev"
- #undef TT_VERSION_SUBSTR
+ #define TT_VERSION_SUBSTR            "dev"
+ //#undef TT_VERSION_SUBSTR

ttssh2/ttssh/ttxssh-version.h
Increment TT_VERSION_MINOR.

  #define TTSSH_VERSION_MAJOR             3
- #define TTSSH_VERSION_MINOR             6
+ #define TTSSH_VERSION_MINOR             7
  #define TTSSH_VERSION_PATCH             0

doc\en/ja\html\about\history.html
Add template of changelog for next release.
Commit and push and merge.
e.g. A commit to increment the version and add a changelog template
Delete a working branch.

Fix the stable branch.

git switch stable_5_6
git pull --rebase
git checkout -b release/unfroze

teraterm/common/tt-version.h
Increment TT_VERSION_PATCH and set SUBSTR to "dev."

  #define TT_VERSION_MAJOR             5
  #define TT_VERSION_MINOR             6
- #define TT_VERSION_PATCH             0
- //#define TT_VERSION_SUBSTR            "dev"
- #undef TT_VERSION_SUBSTR
+ #define TT_VERSION_PATCH             1
+ #define TT_VERSION_SUBSTR            "dev"
+ //#undef TT_VERSION_SUBSTR

ttssh2/ttssh/ttxssh-version.h
Increment TTSSH_VERSION_PATCH.

  #define TTSSH_VERSION_MAJOR             3
  #define TTSSH_VERSION_MINOR             6
- #define TTSSH_VERSION_PATCH             0
+ #define TTSSH_VERSION_PATCH             1

doc\en/ja\html\about\history.html
Add template of changelog for next release.
Commit and push and merge.
e.g. A commit to increment the version and add a changelog template
Delete a working branch.

When stable release,

Fix the stable branch.

git switch stable_5_4
git pull --rebase
git checkout -b release/unfroze

teraterm/common/tt-version.h
Increment TT_VERSION_PATCH and set SUBSTR to "dev."

  #define TT_VERSION_MAJOR             5
  #define TT_VERSION_MINOR             5
- #define TT_VERSION_PATCH             2
- #undef TT_VERSION_SUBSTR
+ #define TT_VERSION_PATCH             3
- //#define TT_VERSION_SUBSTR            "dev"
- #undef TT_VERSION_SUBSTR
+ #define TT_VERSION_SUBSTR            "dev"
+ //#undef TT_VERSION_SUBSTR

ttssh2/ttssh/ttxssh-version.h
Increment TTSSH_VERSION_PATCH.

  #define TTSSH_VERSION_MAJOR             3
  #define TTSSH_VERSION_MINOR             5
- #define TTSSH_VERSION_PATCH             2
+ #define TTSSH_VERSION_PATCH             3

doc\en/ja\html\about\history.html
Add template of changelog for next release on stable branch.
Commit and push and merge.
e.g. A commit to increment the version and add a changelog template
Delete a working branch.

Modify changelog (only for stable releases).

Fix the main branch.
Copy changelogs from stable release, and delete them from periodic release.

git switch main
git pull --rebase
git checkout -b port/changelog

doc\en/ja\html\about\history.html
e.g. A commit to apply the stable release changelog to the main branch
Commit and push and merge.
Delete a working branch.

Configure GitHub Milestones (only for periodic releases).

Close the milestone of released version.
Create the new milestone for next periodic release version. (e.g. "5.5.0")
Rename the milestone to reflect a version after the upcoming release. (e.g. change "5.5.0 or later" to "5.6.0 or later")
Move all issues in this milestone to the "next release" milestone.

The Milestone of stable release is not to be created.

Check for download a installer binary.

When execute a download binary, SmartScreen alerts "Windows protected your PC."

When download a binary with Microsoft Edge, Smart screen warns "File is not commonly downloaded."

Anti-Virus Software may reports false positive.

Update Chocolatey (https://community.chocolatey.org/packages/teraterm5).

Please refer to the Chocolatey page (in Japanese) in the wiki for update instructions.

If the binary you push is being detected by antivirus software, its publication may be suspended.
Since it appears that the same version cannot be pushed multiple times, mistakes during the push process are not allowed.

How to release Tera Term installation package

Start release operation

Create RC, and aftet that

Release

About code freeze.