irkerhook - クラウドでオンライン

プログラム：

NAME

irkerhook - irker 通知を発行するリポジトリ フック スクリプト

SYNOPSIS

irkerhook.py [-n] [-V] [[--変数=値...]] [[コミット ID...]]

DESCRIPTION

irkerhook.py は、コミット後のフックから呼び出されることを意図した Python スクリプトです。
バージョン管理リポジトリ。 その仕事は、発生したコミットに関する情報を収集することです
フック (および場合によってはリポジトリ所有者によって設定された設定) を送信し、その情報を送信します。
さまざまなアナウンス チャネルに転送するための irkerd のインスタンスに。

irkerhook.py の適切な呼び出しと動作は、VCS によって異なります。
（バージョン管理システム）がそれを呼び出しています。 XNUMX つの異なる場所があります。
情報を抽出:

1. VCS ユーティリティの呼び出し。

2. ユーザー設定可能な構成変数をサポートする git のような VCS では、
接頭辞「irker.」。

3. 他の VCS では、リポジトリの内部にある構成ファイル「irker.conf」
ディレクトリにあります。

4. --variable=value 形式のコマンドライン引数。

次の変数は、サポートされているすべての VCS に共通です。

プロジェクト
プロジェクトの名前。 比較的短い識別子にする必要があります。 普通に現れる
通知の最初に。

レポ
リポジトリの最上位ディレクトリの名前。 指定しない場合、デフォルトは
プロジェクト名の小文字のコピー。

チャンネル
IRC チャンネルの URL、または同じものをコンマで区切ったリストで、チャンネルを識別します。
通知が送信されます。 指定しない場合、デフォルトは freenode #commits です。
チャンネル。


通知を中継する irker デーモンが存在すると予想されるホスト。
デフォルトは「localhost」です。

email
設定すると、通信に TCP や UDP ではなく電子メールを使用します。 値は、
対象のメールアドレス。

TCP
「true」の場合、通信に TCP を使用します。 「false」の場合、UDP を使用します。 デフォルトは「false」です。

URLプレフィックス
リポジトリのチェンジセット URL プレフィックス。 これにコミット ID を追加する場合は、
cgit、gitweb、または同様のものを介してコミットを表示する CGI をポイントします。
典型的な gitweb/cgit セットアップを使用している場合は、おそらくデフォルトで機能します。

この変数の値が「なし」の場合、commit での URL フィールドの生成
通知が抑制されます。 他の魔法の値は、「cgit」、「gitweb」、および
これらのシステムで通常動作する URL テンプレートに展開される「viewcvs」。

このURLにはマジッククッキー「%(host)s」と「%(repo)s」が発生する場合があります。前者は
irkerhook.py が実行されているホストの FQDN に展開されます。 後者は
「repo」変数の値に展開されます。

小型化
URL を圧縮するためのサービスを指し示す URL テンプレート。
通知行のスペース。 この変数の値が「なし」の場合、いいえ
圧縮が試みられます。

カラー
「mIRC」の場合、通知フィールドを mIRC カラー コードで強調表示します。 「ANSI」の場合はハイライト
ANSI カラー エスケープ シーケンスを含む通知フィールド。 デフォルトは「なし」（色なし）です。
ANSI コードは、Chatzilla、irssi、ircle、および BitchX でサポートされています。 mIRC コードのみ
mIRC、XChat、KVirc、Konversation、または weechat で認識されます。

注: これをオンにして、チャンネルに通知が表示されなくなった場合は、
そのチャンネルのIRCのカラーフィルターをオフにします。 これを行うには、opが必要です
特権; コマンド「/モード」を発行します-c」であなたの
チャンネル名。 最初にコマンド「/msg chanserv set」を発行する必要がある場合があります
MLOCK +nt-slk".

最大チャネル数
整数として解釈されます。 ゼロでない場合、フックが使用するチャンネル数を制限します
「channels」変数から解釈します。

この変数は、VCS 設定変数または irker.conf を介して設定することはできません。 できる
コマンドライン引数でのみ設定できます。 したがって、リポジトリのある鍛造サイトで
所有者はコミット後のスクリプトを変更できませんが、サイト管理者は変更できます
悪意のあるプロジェクト オーナーによるショットガン スパムを防止するために設定します。 値に設定する
ただし、2 未満はおそらく賢明ではありません。

シアライク
空ではなく、「なし」(デフォルト) でない場合、これは古い CIA の動作をエミュレートします。
ファイルの長いリストを削除して、フォームの要約を優先します (M の N ファイル
ディレクトリ）。 値は、長さのしきい値を示す数値でなければなりません。
文字のファイルリスト。

git
git では、このフックを (更新フック内から) 呼び出す通常の方法で、
refname の後にコミットのリストが続きます。 なぜなら git リビジョンリスト 通常、ほとんどのリストから
--reverse を使用して通知を省略します。
年代順。 通常の更新スクリプトでは、呼び出しは次のようになります。

参照名=$1
古い=$2
新規=$3
irkerhook.py --refname=${refname} $(git rev-list --reverse ${old}..${new})

ただし、irkerhook.py の絶対パスが必要です。

テスト目的と下位互換性のために、irkerhook.py を何も指定せずに呼び出すと、
引数 (コミット後のフックのように) のように呼び出されたかのように動作します。
この：

irkerhook.py --refname=refs/heads/master HEAD

ただし、デフォルト以外のブランチにプッシュすると、正しい結果が得られません。
ベアレポ。

このフックをインストールする一般的な方法は、実際には post-receive フックにあります。
必要なすべての詳細を入力し、失敗してもプッシュを中止しません。 以下を使用します
スクリプト：

#!/bin/sh

echo "IRC 通知を送信しています"
while read old new refname; 行う
irkerhook --refname=${refname} $(git rev-list --reverse ${old}..${new})
行われ

便宜上、これは irkerhook-git ヘルパー スクリプトによって実装されています。

設定は、[irker] セクションのリポジトリ構成ファイルで設定できます。 ここに例があります
それがどのように見えるか：

[アーカー]
プロジェクト = gpsd
色 = ANSI
チャンネル = irc://chat.freenode.net/gpsd,irc://chat.freenode.net/commits

「リポジトリ」変数を設定しないでください (同等の値が計算されます)。 試行なし
irker.conf ファイルを解釈するように作られています。

「プロジェクト」変数のデフォルト値は、リポジトリ ディレクトリのベース名です。
「urlprefix」変数のデフォルト値は「cgit」です。

コミットのフォーマットを制御する git 固有の変数「revformat」が XNUMX つあります。
通知の識別子。 次の値を持つ場合があります。

生
コミットの完全な XNUMX 進数 ID

短い
12 進数 ID の最初の XNUMX 文字

説明する
最後のタグに関連して説明し、短いものにフォールバックします

デフォルトは「記述」です。

転覆
Subversion では、irkerhook.py は --repository オプションに値 (絶対
Subversion リポジトリのパス名) と commit 引数 (リビジョン レベルの数値)
コミットの）。 デフォルトは、それぞれ現在の作業ディレクトリと HEAD です。

ただし、次のことに注意してください。 Subversion 内のデフォルトのリポジトリ引数
ポストコミットフック; これは、Subversion の制限によるものです。
現在のディレクトリは、これらのフック内では信頼できません。 代わりに、値は XNUMX つでなければなりません
Subversion がそのフックに引数として渡す引数。 したがって、典型的な呼び出し
コミット後のスクリプトは次のようになります。

レポ=$1
REV=$2
irkerhook.py --repository=$REPO $REV

他の --variable=value 設定もコマンドラインで指定でき、上書きされます
irker.conf ファイル内のすべての設定。

プロジェクト変数のデフォルトは、リポジトリのベース名です。 デフォルト値
「urlprefix」変数の「viewcvs」です。

リポジトリのルート ディレクトリ (チェックアウト ディレクトリではない) に irker.conf ファイルが存在する場合
ただし、「フォーマット」ファイルなどの内部が存在する場合) フックは変数を解釈します
そこから設定。 このようなファイルがどのように見えるかの例を次に示します。

# irker プロジェクトの irkerhook 変数設定
プロジェクト = アーカー
チャンネル = irc://chat.freenode/irker,irc://chat.freenode/commits
TCP = 偽

このファイルに「リポジトリ」または「コミット」変数を設定しないでください。 それは不幸だったでしょう
結果。

Subversion 固有の変数はありません。

活発
Mercurial では、irkerhook.py は XNUMX つの方法で呼び出すことができます: Python フックとして
(推奨) またはスクリプトとして。

Python フックとして呼び出すには、"commit" または "incoming" フックに以下を追加します。
Mercurial リポジトリでの宣言:

[フック]
着信.irker = python:/path/to/irkerhook.py:hg_hook

スクリプトとして呼び出されると、フックは --repository オプションと値 (絶対
Mercurial リポジトリのパス名) および commit 引数 (Mercurial ハッシュ
コミットの ID またはそれへの参照)。 リポジトリ引数のデフォルトは
カレントディレクトリ。 デフォルトの commit 引数は「-1」で、現在のヒントを指定します
コミット。

git に関しては、どちらの場合も、すべての変数を [irker] 内のリポジトリ hgrc ファイルに設定できます。
セクション。 コマンドライン variable=value 引数は受け入れられますが、スクリプトには必須ではありません
呼び出し。 irker.conf ファイルの解釈は試みられません。

「プロジェクト」変数のデフォルト値は、リポジトリ ディレクトリのベース名です。
「urlprefix」変数のデフォルト値は、「web.baseurl」構成の値です。
値 (存在する場合)。

フィルタリング
irkerd に送信する前にコミットをフィルタリングすることができます。

を指定する必要があります フィルターコマンド このオプションは、irkerhook.py が実行するコマンドになります。
このコマンドは、commit の JSON 表現である XNUMX つの引数を受け入れる必要があります。
エクストラクタ メタデータ (channels 変数を含む)。 コマンドは標準に発行する必要があります
(変更されている可能性がある) メタデータの JSON 表現を出力します。

以下はフィルターの例です。

#!/ usr / bin / env パイソン
# これはメタデータ フィルターの簡単な例です。
# コミットの作成者の名前を変更するだけです。
#
インポートsys、json
メタデータ = json.loads(sys.argv[1])

metadata['author'] = "偉大でパワフルなオズ"

印刷 json.ダンプ(メタデータ)
＃ 終わり

標準エラーは、進行状況とエラー メッセージのフックで使用できます。

OPTIONS

irkerhook.py は次のオプションを取ります:

-n
デーモンへの送信を抑制します。 代わりに、生成された JSON リクエストを
標準出力。 デバッグに役立ちます。

-V
プログラムのバージョンを stdout に書き込み、終了します。

onworks.net サービスを使用してオンラインで irkerhook を使用する