#author("2019-03-01T08:01:42+09:00","default:webadmin","webadmin")
#author("2019-12-12T17:49:47+09:00","","")
* AutoTicketLink: 外部チケットシステムへの自動リンク機能 [#g898dcd6]

#contents

----

特定のフォーマットで記述した文字列を、外部のチケットシステムへ自動リンクする機能です。[[InterWiki]] と違い、角括弧2つ [[ ... ]] でページ名を囲む必要がありません。利用頻度の高いサイトへのリンクを短い文字列で表現できます。

- (1) JIRA形式の文字列を自動でリンク
- (2) 設定したkeyとチケットIDをコロン(:) で繋いだ文字列

動作例:
- (JIRA形式)
-- PKW-2484 で https://pukiwiki.osdn.jp/dev/?BugTrack/PKW-2484 へリンク
- (key形式)
-- phpbug:47689 と書くと https://bugs.php.net/bug.php?id=47689 にリンクされます。(Redmine type)
-- pwjira:PKW-2420 JIRA Issue形式のリンク
-- pukiwiki-commit:bdd91ef0e3092b4b29 Git revision/commit 形式

----

key形式に対して用意されているtypeは3種類(redmine,jira,git)です。

|type|形式|詳細|例|h
|redmine|数字|チケットを数値のみで表すシステム全般に利用可能|myredmine:123|
|jira|大文字英数-数字|JIRAチケット風|myjira:BUG-123|
|git|git revision|git revision8文字以上|commit:bdd91ef0e3|


** 設定方法 (JIRA形式) [#ma31821d]

*** JIRAプロジェクト単位で設定 [#i15dd9fc]


[[AutoTicketLinkName]] のページを編集し、JIRAサーバー、プロジェクトをリスト形式で設定する


 - jira https://pukiwiki.osdn.jp/dev/?BugTrack/
 -- PKW PukiWiki issue $1
 -- PRJ2 PukiWiki Project2 issue $1
 -- PRJ3 PukiWiki Project3 issue $1
 - jira https://issues.example.com/
 -- BUG Example bug $1

1行目先頭の "jira" は固定。続けてチケットに対するベースURLを記述する。

2行目以降、(JIRA Project key) (タイトル) のように記述する。"$1" は Issue key そのものを表す文字列に置換される。

JIRA URL、プロジェクトはそれぞれ複数設定できる。

Wiki利用ユーザーが編集可能です。(初期状態ではページ凍結されています)

*** JIRA風の文字列をすべてリンクする [#id23c3bb]

pukiwiki.ini.php の中の $ticket_jira_default_site の設定を変更する。

 // AutoTicketLink - JIRA Default site
 $ticket_jira_default_site = array(
        'title' => 'My JIRA - $1',
        'base_url' => 'https://issues.example.com/jira/browse/',
 );

PukiWikiの管理者のみ設定可能です。


** 設定方法 (key形式) [#g7bbb091]

pukiwiki.ini.php で $ticket_link_sites に各チケットシステムの情報を設定する。

 /////////////////////////////////////////////////
 // AutoTicketLink
 $ticket_link_sites = array(
	array(
		'key' => 'phpbug',
		'type' => 'redmine', // type: redmine, jira or git
		'title' => 'PHP :: Bug #$1',
		'base_url' => 'https://bugs.php.net/bug.php?id=',
	),
	array(
		'key' => 'asfjira',
		'type' => 'jira',
		'title' => 'ASF JIRA [$1]',
		'base_url' => 'https://issues.apache.org/jira/browse/',
	),
	array(
		'key' => 'pukiwiki-commit',
		'type' => 'git',
		'title' => 'PukiWiki revision $1',
		'base_url' => 'https://ja.osdn.net/projects/pukiwiki/scm/git/pukiwiki/commits/',
	),
 );


|設定項目|説明|備考|h
|key   |チケットの前につけるプリフィクス||
|type  |redmine,jira,git のいずれか||
|title |リンクタイトルの指定 $1 がチケットID を表す||
|base_url|組み合わせるURL||


PukiWikiの管理者のみ設定可能です。


** 補足 [#j15d7a82]

- リンクが有効になるために、前後に半角スペースが必要です。
- JavaScriptでリンクを生成しています。


** 関連ページ [#neec6060]

- [[dev:BugTrack/2420]] AutoTicketLink 外部チケットへの自動リンク
- [[dev:BugTrack/2484]] JIRA形式の文字列を自動リンク

** コメント [#l14f6a1d]
- dfdf -- [[test]] &new{2019-12-12 (木) 17:49:47};

#comment

トップ   編集 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Site admin: PukiWiki Development Team

PukiWiki 1.5.3+ © 2001-2020 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u12. HTML convert time: 0.045 sec.

OSDN