/ShachikuVCS

ShachikuVCS for WinSCP Extensions

Primary LanguagePowerShellMIT LicenseMIT

ShachikuVCS for WinSCP

shckvcs


概要

社畜VCS(Version Control System)はファイルの変更履歴の保存・管理を行う簡易版バージョン管理ツールです。
Git、SVNといった有名なバージョン管理ツールに比べるとはるかに機能が限定されますが、社畜VCSは
定番FTPクライアントソフトWinSCPのエクステンションとして機能しワンタッチインストールで
すぐ使えることが可能であり、WinSCPを介して通信を行うためセキュアで安全にファイルを扱うことができます。
また直観的なUIで間違ってクローズドソースをネットに公開してしまったなどの誤操作も未然に防ぐことが可能です。

開発ツールが満足に準備できない、ソースコード管理に人件費コストを掛けられない。
プロジェクトが炎上中で超短期スケジュールでとにかく人手も時間も無い、などの
ありとあらゆる開発シーンにおいて効果が期待できます。

動作環境

社畜VCSを動作するにはWindowsがインストールされたパソコンで
以下のソフトがインストールされているか確認してください。

フリーソフト名 バージョン
PowerShell 5.1以上
WinSCP 5.19以上
WinMerge 2.16以上

ワンタッチインストール

  1. WinSCPを起動し、リモートサーバーに接続します。

  2. リモートディレクトリのペインを右クリックで
    静的カスタムコマンドカスタマイズをクリックします。

shckvcs_setup1

  1. 追加(A)右側のプルダウンをクリックして拡張機能の追加(E)をクリックします。

shckvcs_setup4

  1. 拡張機能の追加画面のURLにコピーしたGitHubのRawリンク を貼り付けします

shckvcs_setup5

  1. OKをクリックします。
    (※以下のような警告メッセージが表示されますが特に問題はありませんのでOKをクリックして進めます。)

shckvcs_setup2

  1. 環境設定ウィンドウに戻って、3.のカスタムコマンド一覧にVCS MENUが表示されることを確認してください。

  2. これでインストールは完了です
    (※なお初回起動時は初期設定が完了しましたとメッセージ表示されるだけですが
    ホームディレクトリに専用フォルダと設定ファイルが作成され、起動準備が完了します。)


アンインストール

Windowsのホームディレクトリ(例:C:¥Users¥(ユーザ名)に作成された
ShckConfig.xml.shchk フォルダを削除すればアンインストール完了です。


使い方

社畜VCSメニュー画面の表示

  1. WinSCPを起動し、リモートサーバーに接続します。

  2. リモートディレクトリのペインから管理対象のソースを選択し、
    右クリックで ファイルカスタムコマンドVCS MENUをクリックします。

  3. 社畜VCSメニュー画面が表示されます。
    (※初回起動時に「初期設定が完了しました」とメッセージ表示された場合は再度メニューからクリックしてください。)

社畜VCS機能の紹介

画面イメージ

shckvcs_setup3

操作ボタンの説明

  1. 選択したソースをコミットする場合はコメントを入力してコミットをクリックします。
    履歴一覧に入力コメントが追加されます。
  2. リモートファイルとリポジトリを比較する場合は履歴一覧から選択してリモートファイルと比較
    クリックします。
  3. 直近リポジトリとの差分を確認したい場合は履歴一覧から選択して前回リビジョンとの差分を表示
    クリックします。
  4. リポジトリをリモートに戻す場合は履歴一覧から選択してリバートをクリックします。
    注意!
    リモートファイルが書き換わって戻せなくなるので
    必ず上司に承認をとってから操作を行ってください。
  5. リポジトリをバックアップしたい場合は履歴一覧から選択してエクスポートをクリックして
    保存先を選択してください。
  6. コメントを修正したい場合は履歴一覧から選択してコメント編集をクリックして編集後
    コメント更新をクリックします。
  7. 履歴一覧内容を絞り込みたい場合は画面上部テキストボックスに文字列を入力して
    検索をクリックします。
  8. 上記検索条件をクリアする場合はクリアをクリックします。
  9. 画面を閉じる場合は閉じるをクリックします。

設定ファイル(ShckConfig.xml)の説明

インストール時に自動作成されたShckConfig.xmlの設定を変更することで
画面項目をカスタマイズすることが可能です。

複数でリポジトリを管理共有したい場合は、history work_dir の保存先を
共有フォルダのパスに変更してください。

パラメータ名 説明 デフォルト値
pgname プログラム名をメッセージに表示します 社畜VCS
version プログラム名を画面に表示します 社畜VCS for WinSCP
capt_lblHistory ラベル名です 履歴一覧
capt_txtFindComment ラベル名です コメント検索
capt_btnClear ボタン名です クリア
capt_btnFind ボタン名です 検索
capt_ttlDT ラベル名です 日時
capt_ttlUsrName ラベル名です 利用者
capt_ttlRevisionID ラベル名です リビジョンID
capt_ttlFileName ラベル名です ファイル名
capt_ttlRemoteDirectory ラベル名です リモートディレクトリ
capt_ttlLocalPath ラベル名です ローカルパス
capt_ttlComment ラベル名です コメント
capt_ttlRevertFlag 未使用 リバートFLG
capt_lblRevID 未使用 リビジョンID
capt_lblRmtPath 未使用 リモートパス
capt_lblComment ラベル名です コメント
capt_lblCmtComment ラベル名です コメントを入力してください
capt_btnCheckRcnt ボタン名です リモートファイルと比較
capt_btnCheckSel ボタン名です 前回リビジョンとの差分を表示
capt_btnRevert ボタン名です リバート
capt_btnExport ボタン名です エクスポート
capt_btnComment ボタン名です コメント編集
capt_btnUpdate ボタン名です コメント更新
capt_btnCommit ボタン名です コミット
capt_btnCan ボタン名です 閉じる
capt_btnCcl ボタン名です 編集キャンセル
capt_msgCfm メッセージ内容です 本当によろしいですか?
capt_msgReboot メッセージ内容です 初期設定が完了しました。
history 履歴ファイルのディレクトリパスが入ります C:\Users\(ユーザ名).shchk\ShckHistory.xml
work_dir リポジトリを保存するディレクトリパスが入ります C:\Users\(ユーザ名).shchk|