変更とコミット#

リポジトリとして登録された状態になると、「コミット」という単位で変更履歴が管理されます。コミットはTwinCATで変更を加えるたびに行うのではなく、意味のある変更単位でまとめると、後々のトレーサビリティ上便利です。サンプルプログラムとして、0.5秒間隔でON/OFFを繰り返すBlinkerファンクションブロックを、ST、FBD、LD、CFCで作成したものをベースとします。

FUNCTION_BLOCK ST_blinker
VAR_INPUT
	execute:BOOL;
END_VAR
VAR_OUTPUT
	output:BOOL;
END_VAR
VAR
	delay: TON;
END_VAR

delay(IN := NOT delay.Q, PT := T#0.5S);
output := (NOT output AND delay.Q) OR (output AND NOT delay.Q) AND execute;

上記ファンクションブロックを次の通りMAINプログラムで使います。

PROGRAM MAIN
VAR
	button1:BOOL;
	button2:BOOL;
	button3:BOOL;
	button4:BOOL;
	light1:BOOL;
	light2:BOOL;
	light3:BOOL;
	light4:BOOL;
	blinker1 :FBD_blinker;
	blinker2 :LD_blinker;
	blinker3 :ST_blinker;
	blinker4 :CFC_blinker;
END_VAR

blinker1(execute := button1,output => light1);
blinker2(execute := button2,output => light2);
blinker3(execute := button3,output => light3);
blinker4(execute := button4,output => light4);

この節の例では、このサンプルプログラムに対して次の順に変更とコミットを行う手順について説明します。

点滅間隔を任意の時間で設定可能にする変更を加える
さらにON/OFFのデューティを設定できるようにする

これらの変更を加えて、個別にコミットする方法について説明します。

TwinCATプロジェクトの変更#

***_blinker 全てのファンクションブロックに、「点滅間隔を任意の時間で設定可能にする」の変更を加えてみます。すると、次図の通り前回のコミット（現時点では初期登録時点）から変更を加えたリソースのアイコンの左側に赤色チェックマークがオーバレイされ、変更が加えられたことが分かる様になっています。

変更マークがついたリソースに対しては、コンテキストメニューによりGitの各操作が可能となっています。

メニュー	説明
Undo…	前回のコミット状態まで戻す。
Commit…	加えた変更をリポジトリへ反映する。
View History…	コミット履歴を一覧する。
Compare and Unmodified…	ファイル内の比較を表示し、部分的にロールバック編集する。
Blame(annotate)	ファイルの行単位で最新の変更が加えられたコミットを一覧する。ただし、TcPOUなど生のファイルの状態で表示される。

例えば、変更を加えたFBD_blinkerの変更箇所を見る場合は、コンテキストメニューからcompare with Unmodified...を選択します。

すると、TwinCAT用の差分ビューワの登録で設定したTcProjectCompareが起動し、前回コミットした時点からの変更点がハイライトされるウィンドウが起動します。左側が変更前、右側が変更後のペインとなります。

他にもST言語の差分は次の通り表示されます。

差分ツールを使った、部分的な変更箇所のロールバックなどの修正方法については、付録：TcProjectCompareの操作方法にて説明します。

変更をコミットする#

リポジトリへ変更を反映することをコミットといいます。コミットを行うには、TwinCATトップレベルのコンテキストメニューからCommit...を選んでください。

コミットウィンドウが現れます。コミットには二つの方法があります。

全ての変更をコミットする場合: 図 3.1の通り、Changesのファイルを全て確認の上、コミットコメントを記述し、そのままCommit Allボタンを押すと、全ての変更がコミットされます。
ステージに上げられたファイルのみコミットする場合: 図 3.2の通り、コミットしたいファイルを選択し、Staged Changesに上げられたものだけをコミットできます。同様にコミットコメント記述後、Commit Stagedボタンを押す事でステージに上げられたファイルのみコミットされます。

ステージへ上げる方法は、ファイルをひとつづつ選択する方法と、全変更をステージに一度上げる方法があります。

図 3.1 全てのファイルをコミットする手順#

図 3.2 一部のファイルのみコミットする手順#

図 3.3 全ファイルをステージに上げる#

次の手順でコミットを行うと良いでしょう。

変更対象ファイルを確認する。

Changesツリーには、変更されたファイルのみが一覧されます。全てを差分エディタで変更点をチェックし、今回の目的に有ったファイルのみ選択する必要が有る場合、ステージコミットを、全てのファイルが同一の目的の変更であることが分かったら、全コミットを行ってください。

コミットの単位にご注意

コミットの単位で変更が管理されます。このため、不具合修正、単なるリファクタリング、機能追加など、意味のある単位でコミットを行うことで、後から目的の変更がいつ、誰が、どのブランチで行われたのか、追跡する事が容易になります。

コミットコメントを記述する。

次のとおり、プレフィックスに続いて何等かのコメントを記述すると良いでしょう。後から検索しやすくするためです。

feat: Make blinker FB blinking interval configurable.

プレフィックスは独自に定義いただくのが良いのですが、迷う場合は以下のような一覧をご参考ください。

プレフィックス	説明
feat	新しい機能
fix	バグの修正
docs	ドキュメントのみの変更
style	空白、フォーマット、セミコロン追加など
refactor	仕様に影響がないコード改善(リファクタ)
perf	パフォーマンス向上関連
test	テスト関連
chore	ビルド、補助ツール、ライブラリ関連

最後に、Commit AllまたはCommit Stagedボタンを押すと、コミットが行われます。

TwinCAT 3.1 Build 4024では行単位のステージはできません

Gitコマンドでは行単位でのステージングが可能なgit add -pコマンドがあります。しかし、行単位のステージコミットは、Visual Studio 2022のバージョン17.3以降でなければ対応しません。TwinCAT3.1 Build 4024はVisual Studio 2019をベースにしているため、この機能はありません。よって、VSCodeなどの他のGitクライアントをお使いください。ただし、この場合TcPOUのXML形式のファイルを直接編集する事になります。他のGitクライアントでも部分コミットを可能にするためには、プログラムをST言語に限定してお使いいただく事をお勧めします。

例えば、Gitリポジトリで管理されたTwinCATプロジェクトフォルダをVSCodeでプロジェクトを開くと、変更のあるTcPOUファイルがSource controlツリーに一覧されます。一旦全てをStagedに上げてから、任意の行を選択してUnsatage Selected Rangesを選択します。