リリースの手順

リリース作業の開始
RC作成とその後
リリース作業
コードフリーズについて

TeraTerm Project でのリリース手順について以下に示します。

リリース作業の開始

チケット、ブランチなどを確認する
- プロジェクトチーム内で確認する
  - 今回のリリースに入れるもの・次回以降に延期するものを整理・決定する
- ブランチをマージする
  - 作業ブランチを main ブランチへマージする
  - 作業ブランチのコミットを "安定版ブランチへマージするためのブランチ" へ cherry-pick し、安定版ブランチへマージする
- issue をクローズする
  - すでに修正済み、処理済みのものはクローズする
    リリース時には、対象のマイルストーンのチケットはすべてクローズされている状態になる
  - 次のリリースへ回すものはマイルストーンを変更する
    次のリリース用マイルストーンを作成する
- この時点で新たに出てくるチケットの対応を検討する
ツール、ライブラリ、インポート元の最新版をチェックする
- Visual Studio (「更新プログラムの確認」から更新する)
- 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-jp.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/)
リリースビルドには CI ツールを使っているため、Visual Studio の詳細バージョンはコントロールできない。どのバージョンになるかは、ビルド時点で CI ツールがどのバージョンを採用しているかに左右される。

リリースに使うライブラリのバージョンはこの時点でおおむね決定する。

安定版リリースでは、ライブラリは元になった定期リリースから更新しない。（ライブラリにセキュリティ修正がある場合は個別に検討する。）
今回のリリースに入れたいものが落ち着く

RC 作成とその後

RC 作業ブランチを作成する（main ブランチ、または安定版リリース用ブランチから）
```
git switch main
git pull --rebase
git checkout -b release/5_4_0-RC
```
ドキュメントを確認する
- ダイアログ上の設定項目・UIのない特別オプション・コマンドラインパラメータ・新規マクロコマンドなど、対応するドキュメントに漏れがないか確認する。
- 変更履歴を確認し、書き忘れがあれば追記する。
- 変更履歴の順番を変更する。重要なものが先に来るようにする。だいたいの指針としては、ターミナルエミュレーション関係・アプリケーションとしての変更・マクロの順。
- ドキュメント変更点が翻訳されていることを確認し、翻訳忘れがあれば翻訳する。
この年における最初のリリースの場合は、著作権表示の「最後の発行の年」をインクリメントする
- 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
- 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
バージョンをインクリメントする
- teraterm\common\tt-version.h
  TT_VERSION_SUBSTR を "RC" にする
```
  #define TT_VERSION_MAJOR             5
  #define TT_VERSION_MINOR             4
  #define TT_VERSION_PATCH             0
- #define TT_VERSION_SUBSTR            "dev"
+ #define TT_VERSION_SUBSTR            "RC"
  //#undef TT_VERSION_SUBSTR
```
  TT_VERSION_MINOR または TT_VERSION_PATCH は、前回のリリース直後にインクリメントされている。
- ttssh2\ttxssh\ttxssh-version.h
  TTSSH_VERSION_MINOR または TTSSH_VERSION_PATCH は、前回のリリース直後にインクリメントされている。
- ttpmenu\ttpmenu.rc // 変更時のみ
- TTProxy\TTProxy.rc // 変更時のみ
- TTXKanjiMenu\ttxkanjimenu.rc // 変更時のみ
インストーラを作成する（確認用）
サポートされている全 OS でインストーラの実行、起動、接続をチェックする
コミット、push する
作業ブランチをマージするための Pull Request を作成する
Pull Request をマージする（main ブランチ、または定期リリース用ブランチへ）
GitHub Actions で workflow が実行されてビルドされる
ビルドは3回実行されます:
- 作業ブランチへの push
- Pull Request の作成
- main ブランチ、または安定版ブランチへのマージコミット
RC の作成では「マージコミットによるビルドバイナリ」を RC 成果物とします。
RCの作成をアナウンスする
- X (https://x.com/Tera_Term)
- 問題の報告はここにあるように GitHub の Issues を案内する。
- GitHub Actions の Artifacts は、GitHub にログインしていないとダウンロードできないことを注記する。
- 例: 5.5.1 RC
作業ブランチを削除する
フィードバックを受け入れる
修正が入ったら再度「ドキュメントを確認する」「サポートされている全 OS で起動・接続チェックする」
RC2 を出す場合は、この項目の手順を作業ブランチの作成から再度行う

リリース作業

アナウンス文面を考えておく
- GitHub の Release 用
  ドキュメントの変更履歴からリリースノートの概要をまとめる（日本語・英語ともに）
  ユーザに影響の大きい数項目をピックアップする
  例: 5.5.1
- X でのアナウンス用
  140文字に収まるように短くまとめる（日本語のみ）
  例: 5.5.1
作業ブランチを作成する（main ブランチ、または安定版リリース用ブランチから）
```
git switch main
git pull --rebase
git checkout -b release/5_4_0
```
ドキュメントを確認する (詳細は同上)
リリース日を変更する
- html/about/history.html

"RC" を削除する

teraterm\common\tt-version.h

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

インストーラを作成する（確認用）
ビルド・インストーラの生成がエラーなくできることを確認する。
コミット、push する *
作業ブランチをマージするための Pull Request を作成する *
Pull Request をマージする（main ブランチ、または定期リリース用ブランチへ） *
タグを作成し、push する *
タグは annotated tags とする。
タグ名は「v(バージョン)」。（例: 5.4.0ならば "v5.4.0" ）
```
git switch main
git pull --rebase
git tag -a v5.4.0 -m "Release 5.4.0"
git push origin v5.4.0
```
GitHub Actions で workflow が実行されてビルドされる
ビルドは4回実行されます:
- 作業ブランチへの push
- Pull Request の作成
- main ブランチ、または安定版ブランチへのマージコミット
- タグの作成
リリースでは「タグの作成によるビルドバイナリ」をリリース成果物とします。
リリース時に workflow は SignPath にコード署名をリクエストしますが、SignPath の release-signing ポリシーは手動で承認が必要です。そのため workflow は途中で署名リクエストが承認されるのを待ちます。したがって、SignPath.io にログインしておき、署名リクエストを Approve します。
作業ブランチを削除する
GitHub の Releases に追加する
- 上で追加したタグを選択する
- インストーラとポータブル版の zip ファイルとハッシュファイルを追加する
- リリースノートの概要を記述する
ウイルス対策ソフトの検知を確認する
- Chrome でダウンロードしてみる
- Edge でダウンロードしてみる
  Edge は「Defender SmartScreen」は「一般的にダウンロードされていません」の警告を出す。これを正しくない検知として報告する。
プロジェクトWebページ (https://teratermproject.github.io) を更新する
更新のしかたはプロジェクトページの更新手順を参照
リリースをアナウンスする
- X (https://x.com/Tera_Term)
  - アナウンスをポストする。
  - そのポストを固定する。
安定版ブランチを作成する（定期リリースの場合のみ）
```
git switch main
git pull --rebase
git checkout -b stable_5_4
```

次のリリースに向けてバージョンをインクリメントする

定期リリースの場合

main ブランチを修正する。

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

teraterm/common/tt-version.h
TT_VERSION_MINOR を1つ進めて、SUBSTR を "dev" にする。

  #define TT_VERSION_MAJOR             5
- #define TT_VERSION_MINOR             4
+ #define TT_VERSION_MINOR             5
  #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
TTSSH_VERSION_MINOR を1つ進める。

  #define TTSSH_VERSION_MAJOR             3
- #define TTSSH_VERSION_MINOR             4
+ #define TTSSH_VERSION_MINOR             5
  #define TTSSH_VERSION_PATCH             0

doc\en/ja\html\about\history.html
次バージョンの変更履歴のひな形を追加する。

<h3 id="teraterm_5.5.0">YYYY.MM.DD (Ver 5.5.0 not released yet)</h3>
<ul class="history">
  <!--li>Changes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Bug fixes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Misc
    <ul>
      <li>
      </li>
    </ul>
  </li-->
</ul>

<h3 id="ttssh_3.5.0">YYYY.MM.DD (Ver 3.5.0 not released yet)</h3>
<ul class="history">
  <!--li>Changes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Bug fixes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Misc
    <ul>
      <li>
      </li>
    </ul>
  </li-->
</ul>

コミット、push、マージする。
作業ブランチを削除する

安定版ブランチを修正する。

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

teraterm/common/tt-version.h
TT_VERSION_PATCH を1つ進めて、SUBSTR を "dev" にする。

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

ttssh2/ttssh/ttxssh-version.h
TTSSH_VERSION_PATCH を1つ進める。

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

doc\en/ja\html\about\history.html
次バージョンの変更履歴のひな形を追加する。

<h3 id="teraterm_5.4.1">YYYY.MM.DD (Ver 5.4.1 not released yet)</h3>
<ul class="history">
  <!--li>Changes
    <ul>
      <li></li>
    </ul>
  </li-->

  <!--li>Bug fixes
    <ul>
      <li></li>
    </ul>
  </li-->

  <!--li>Misc
    <ul>
      <li></li>
    </ul>
  </li-->
</ul>

<h3 id="ttssh_3.4.1">YYYY.MM.DD (Ver 3.4.1 not released yet)</h3>
<ul class="history">
  <!--li>Changes
    <ul>
      <li></li>
    </ul>
  </li-->

  <!--li>Bug fixes
    <ul>
      <li></li>
    </ul>
  </li-->

  <!--li>Misc
    <ul>
      <li></li>
    </ul>
  </li-->
</ul>

コミット、push、マージする。
作業ブランチを削除する

安定版リリースの場合

安定版ブランチを修正する。

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

teraterm/common/tt-version.h
TT_VERSION_PATCH を1つ進めて、SUBSTR を "dev" にする。

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

ttssh2/ttssh/ttxssh-version.h
安定版ブランチで、TTSSH_VERSION_MINOR を1つ進める。

  #define TTSSH_VERSION_MAJOR             3
  #define TTSSH_VERSION_MINOR             4
- #define TTSSH_VERSION_PATCH             1
+ #define TTSSH_VERSION_PATCH             2

doc\en/ja\html\about\history.html
次バージョンの変更履歴のひな形を追加する。

<h3 id="teraterm_5.4.2">YYYY.MM.DD (Ver 5.4.2 not released yet)</h3>
<ul class="history">
  <!--li>Changes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Bug fixes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Misc
    <ul>
      <li>
      </li>
    </ul>
  </li-->
</ul>

<h3 id="ttssh_3.4.2">YYYY.MM.DD (Ver 3.4.2 not released yet)</h3>
<ul class="history">
  <!--li>Changes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Bug fixes
    <ul>
      <li>
      </li>
    </ul>
  </li-->

  <!--li>Misc
    <ul>
      <li>
      </li>
    </ul>
  </li-->
</ul>

コミット、push、マージする。
作業ブランチを削除する

変更履歴を修正する（安定版リリースの場合のみ）
- main ブランチを修正する。
```
git switch main
git pull --rebase
git checkout -b port/changelog
```
  - doc\en/ja\html\about\history.html
    安定版リリースの変更履歴をコピーし、定期リリースの変更履歴からは削除する。
  - コミット、push、マージする。
  - 作業ブランチを削除する
GitHub の Milestones を調整する（定期リリースの場合のみ）
- リリースしたバージョンの Milestone を close する。
- 次の定期リリースバージョンの Milestone （例: "5.5.0"）を作成する。
- 「次のリリース or later」の Milestone をリネームする。（例: "5.5.0 or later" to "5.6.0 or later"）
  ここに含まれている issue を「次のリリース」の Milestone に移動する。
安定版リリースのマイルストーンは作成しません。
インストーラバイナリのダウンロードに関する確認をする
ダウンロードしたファイルを実行すると、SmartScreen が「WindowsによってPCが保護されました」という警告を出すことがある。
これが解消されないと、窓の杜はインストーラを掲載しない。

Microsoft Edge でダウンロードすると、SmartScreen が「一般的にダウンロードされていません」という警告を出す。

ウイルス対策ソフトが誤検出することがある。
keycode.exe がキーロガーとして検出されやすいらしい。

Microsoft には誤検出の申し立てができる。「PCが保護されました」の解消のため報告する。
- Microsoft アカウントでログインする
- https://www.microsoft.com/en-us/wdsi/filesubmission にアクセスする
- "Software developer" を選んで報告する
Chocolatey の登録を更新する
ウイルス対策ソフトに検出されている状態だと push したバイナリが公開差し止めになることがある。

同じバージョンを複数回 push できないようなので、push 作業をミスることができない。

現在 teraterm5 パッケージは reject されている。

コードフリーズについて

コードフリース中は、原則的には致命的なバグの修正のみ可能となります。
コードフリーズは、RC作成（teraterm.iss に RC を付けるコミット）から（バージョンをインクリメントするコミット）までとします。