GitLabクイックアクション
クイックアクションは、通常GitLabユーザーインターフェイスのボタンやドロップダウンを選択して行う一般的なアクションのテキストベースのショートカットです。これらのコマンドは、イシュー、エピック、マージリクエスト、コミットの説明やコメントに入力することができます。クイックアクションは、新しいコメントや説明文、既存のコメントや説明文を編集するときに実行されます。
多くのクイックアクションはコンテキストを意識しており、特定の条件を満たす必要があります。例えば、/remove_due_date
で課題の期限を削除するには、そのイシューに期限が設定されている必要があります。
GitLab が適切にコマンドを検出して実行できるように、クイックアクションはそれぞれ別の行に入力してください。
パラメータ
多くのクイックアクションはパラメータを必要とします。例えば、/assign
のクイックアクションにはユーザー名が必要です。GitLabはクイックアクションでオートコンプリート文字を使い、ユーザーがパラメータを入力しやすいように、利用可能な値のリストを提供します。
パラメータを手動で入力する場合は、ダブルクォーテーション ("
) で内部を囲む必要があります。ただし、これらの文字だけが含まれている場合は除きます:
- ASCII 文字
- 数字 (0-9)
- アンダースコア (
_
)、ハイフン (-
)、クエスチョンマーク (?
)、ドット (.
)、アンパサンド (&
)、またはアット (@
)
パラメータは大文字と小文字を区別します。オートコンプリートは、この処理と引用符の挿入を自動的に行います。
イシュー、マージリクエスト、エピック
以下のクイックアクションは説明、ディスカッション、スレッドに適用されます。一部のクイックアクションはすべてのサブスクリプション層で利用できない場合があります。
コマンド | イシュー | マージリクエスト | エピック | アクション |
---|---|---|---|---|
/add_contacts [contact:email1@example.com] [contact:email2@example.com] | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 1つ以上のアクティブなCRMコンタクトを追加します(GitLab 14.6で導入)。 |
/approve | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | マージリクエストを承認します。 |
/assign @user1 @user2 | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 1人以上のユーザーを割り当てます。 |
/assign me | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 自分で割り当てます。 |
/assign_reviewer @user1 @user2 または/reviewer @user1 @user2 または/request_review @user1 @user2
| {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 1人または複数のユーザーをレビュアーとして割り当てます。 |
/assign_reviewer me または/reviewer me または/request_review me
| {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 自分をレビュアーに任命してください。 |
/award :emoji: | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 絵文字リアクションを切り替えます。 |
/blocked_by <issue1> <issue2> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | issueを他のissueによってブロックされているとマークします。<issue> の値は、#issue 、group/project#issue 、または完全なイシューURLの形式でなければなりません。(GitLab 16.0で導入されました)。 |
/blocks <issue1> <issue2> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | issueを他のissueのブロックとしてマークします。<issue> の値は、#issue 、group/project#issue 、または完全なイシューURLの形式でなければなりません。(GitLab 16.0で導入されました)。 |
/cc @user | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | ユーザーを指定します。GitLab 15.0以降では、このコマンドはアクションを行いません。代わりにCC @user 、もしくは@user とだけ入力することができます。GitLab 14.9以前では、行頭でユーザーを言及することで、特定のタイプのTo-Doアイテム通知を作成しました。 |
/child_epic <epic> | {点線円}いいえ | {点線円}いいえ | {チェックサークル}はい | に子エピックを追加します<epic> 。 <epic> 値は&epic ,group&epic , またはエピックへの URL の形式でなければなりません。 |
/clear_health_status | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | ヘルスステータスをクリア(GitLab 14.7で導入)。 |
/clear_weight | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | クリアウェイト |
/clone <path/to/project> [--with_notes] | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 引数を指定しない場合は現在のプロジェクトにイシューをクローンします。ターゲットプロジェクトにラベル、マイルストーン、エピックなどの同等のオブジェクトが含まれている限り、可能な限り多くのデータをコピーします。引数として--with_notes が指定されない限り、コメントやシステム・ノートはコピーされません。 |
/close | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 閉じる |
/confidential | {チェックサークル}はい | {点線円}いいえ | {チェックサークル}はい | イシューやエピックに秘密マークを付けます。GitLab 15.6でエピックがサポートされました。 |
/copy_metadata <!merge_request> | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | プロジェクト内の別のマージリクエストからラベルとマイルストーンをコピーします。 |
/copy_metadata <#issue> | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | プロジェクト内の別のイシューからラベルとマイルストーンをコピーします。 |
/create_merge_request <branch name> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 現在のイシューから新しいマージ・リクエストを作成します。 |
/done | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | To-Do 項目を完了としてマークします。 |
/draft | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 下書きステータスを設定します。 |
/due <date> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 期限を設定します。有効な<date> の例には、in 2 days 、this Friday 、December 31st があります。その他の例についてはChronicを参照してください。 |
/duplicate <#issue> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | このイシューをクローズします。イシュー<#issue> の重複、および関連としてマークしてください。 |
/epic <epic> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | エピックに追加<epic> 。値は <epic> &epic ,group&epic , またはエピックへの URL の形式でなければなりません。 |
/estimate <time> または/estimate_time <time>
| {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 推定時間を設定します。例えば、/estimate 1mo 2w 3d 4h 5m 。詳しくはタイムトラッキングをご覧ください。エイリアス/estimate_time GitLab 15.6 で導入されました。 |
/health_status <value> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ |
健康状態を設定します。<value> で有効なオプションはon_track ,needs_attention ,at_risk (GitLab 14.7 で導入)です。 |
/invite_email email1 email2 | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 最大6人の電子メール参加者を追加します。このアクションは機能フラグissue_email_participants 、イシュー・テンプレートではまだサポートされていません。 |
/iteration *iteration:"iteration name" | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 反復を設定。例えば、Late in July の反復を設定するには:/iteration *iteration:"Late in July" . |
/label ~label1 ~label2 または/labels ~label1 ~label2
| {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | つ以上のラベルを追加します。ラベル名はチルダ (~ ) なしで始めることもできますが、混合構文はサポートされていません。 |
/link | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | インシデント内のリンクされたリソースへのリンクと説明を追加します(GitLab 15.5で導入)。 |
/lock | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | ディスカッションをロックしてください。 |
/merge | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 変更をマージします。プロジェクトの設定によっては、パイプラインが成功した場合、またはマージトレインに追加した場合に表示されます。 |
/milestone %milestone | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | マイルストーンを設定します。 |
/move <path/to/project> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | このイシューを別のプロジェクトに移動します。アクセスルールが異なるプロジェクトにイシューを移動する場合は注意してください。イシューを移動する前に、そのイシューに機密データが含まれていないことを確認してください。 |
/page <policy name> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | インシデントのエスカレーションを開始します(GitLab 14.9で導入)。 |
/parent_epic <epic> | {点線円}いいえ | {点線円}いいえ | {チェックサークル}はい | 親エピックを設定します<epic> 。 <epic> 値は&epic ,group&epic , またはエピックへの URL の形式である必要があります。 |
/promote_to_incident | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | イシューをインシデントに昇格させます(GitLab 14.5で導入)。GitLab 15.8以降では、新しいイシューを作成する際にクイックアクションを使うこともできます。 |
/promote | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | イシューをエピックに昇格させます。 |
/publish | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 関連するステータスページにイシューを発行します。 |
/ready | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | レディステータスを設定します(GitLab 15.1で導入)。 |
/reassign @user1 @user2 | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 現在の担当者を指定した担当者に置き換えます。 |
/reassign_reviewer @user1 @user2 | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 現在のレビュアーを指定したレビュアーに置き換えます。 |
/rebase | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | ソースブランチをリベースします。これは、ソースブランチの変更をターゲットブランチの最新のコミットでリベースしようとするバックグラウンドタスクをスケジュールします。/rebase を使用した場合、/merge は無視されます。これは、リベースされる前にソースブランチがマージされたり削除されたりする競合状態を避けるためです。マージが競合した場合、GitLab はリベースがスケジュールできないというメッセージを表示します。リベースの失敗は、マージリクエストステータスとともに表示されます。 |
/relabel ~label1 ~label2 | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 現在のラベルを指定したラベルに置き換えます。 |
/relate #issue1 #issue2 | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | イシューに関連マークを付けます。 |
/remove_child_epic <epic> | {点線円}いいえ | {点線円}いいえ | {チェックサークル}はい | から子エピック を削除します<epic> 。 <epic> 値は&epic ,group&epic , またはエピックへの URL の形式である必要があります。 |
/remove_contacts [contact:email1@example.com] [contact:email2@example.com] | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 1つ以上のCRMコンタクトを削除します(GitLab 14.6で導入)。 |
/remove_due_date | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 期日を削除します。 |
/remove_epic | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | エピックから削除します。 |
/remove_estimate または/remove_time_estimate
| {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 時間の見積もりを削除しました。エイリアス/remove_time_estimate GitLab 15.6で導入されました。 |
/remove_iteration | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 反復を削除します。 |
/remove_milestone | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | マイルストーンを削除します。 |
/remove_parent_epic | {点線円}いいえ | {点線円}いいえ | {チェックサークル}はい | エピックから親エピックを削除します。 |
/remove_time_spent | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 滞在時間を削除します。 |
/remove_zoom | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | このイシューからZoomミーティングを削除します。 |
/reopen | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 再開 |
/severity <severity> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 深刻度を設定します。イシュー・タイプはIncident でなければなりません。<severity> のオプションはS1 … です。S4 ,critical ,high ,medium ,low ,unknown です。GitLab 14.2 で導入されました。 |
/shrug <comment> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | コメントを¯\_(ツ)_/¯ で追加します。 |
/spend <time> [<date>] または/spend_time <time> [<date>]
| {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 費やした時間を加算または減算します。オプションで、時間が費やされた日付を指定します。例えば、/spend 1mo 2w 3d 4h 5m 2018-08-26 または/spend -1h 30m 。詳しくは、時間のトラッキングをご覧ください。エイリアス/spend_time GitLab 15.6で導入されました。 |
/submit_review | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 保留中のレビューを送信します。 |
/subscribe | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 通知を購読します。 |
/tableflip <comment> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | コメントを(╯°□°)╯︵ ┻━┻ で追加します。 |
/target_branch <local branch name> | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | ターゲットブランチを設定します。 |
/timeline <timeline comment> \| <date(YYYY-MM-DD)> <time(HH:MM)> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | このインシデントにタイムラインイベントを追加します。例えば、/timeline DB load spiked \| 2022-09-07 09:30 .(GitLab 15.4で導入)。 |
/title <new title> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | タイトルを変更します。 |
/todo | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | To-Do項目を追加します。 |
/unapprove | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | マージリクエストを承認しません。(GitLab 14.3 で導入)。 |
/unassign @user1 @user2 | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | 特定の担当者を削除します。 |
/unassign_reviewer @user1 @user2 または/remove_reviewer @user1 @user2
| {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | 特定のレビュアーを削除します。 |
/unassign_reviewer me | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | あなた自身をレビュアーから外してください。 |
/unassign_reviewer または/remove_reviewer
| {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | すべてのレビュアーを削除します。 |
/unassign | {点線円}いいえ | {チェックサークル}はい | {点線円}いいえ | すべての担当者を削除します。 |
/unlabel ~label1 ~label2 または/remove_label ~label1 ~label2
| {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 指定されたラベルを削除します。 |
/unlabel または/remove_label
| {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | すべてのラベルを削除します。 |
/unlink <issue> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 指定されたイシューへのリンクを削除します。<issue> の値は、#issue 、group/project#issue 、または完全なイシューURLの形式でなければなりません。(GitLab 16.1 で導入されました)。 |
/unlock | {チェックサークル}はい | {チェックサークル}はい | {点線円}いいえ | ディスカッションのロックを解除します。 |
/unsubscribe | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 通知の配信を停止します。 |
/weight <value> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 重みを設定します。有効な値は0 ,1 ,2 のような整数です。 |
/zoom <Zoom URL> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | このイシューまたはインシデントにZoomミーティングを追加します。GitLab 15.3以降では、GitLab PremiumのユーザーはインシデントにZoomリンクを追加する際に短い説明を追加することができます。 |
作業項目
GitLab 15.10で導入されたコメントからのクイックアクションの実行。
GitLabのワークアイテムにはタスクと OKRがあります。以下のクイックアクションは、ワークアイテムの編集やコメント時に説明フィールドから適用することができます。
コマンド | タスク | 目的 | 主な成果 | アクション |
---|---|---|---|---|
/assign @user1 @user2 | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 1人以上のユーザーを割り当てます。 |
/assign me | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 自分で割り当てます。 |
/cc @user | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | ユーザーを指定します。GitLab 15.0以降では、このコマンドはアクションを行いません。代わりにCC @user 、または@user とだけ入力することができます。GitLab 14.9以前では、行頭でユーザーを言及すると、特定のタイプのTo-Doアイテム通知を作成します。 |
/clear_health_status | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 健康状態をクリアします。 |
/clear_weight | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | クリアウェイト |
/close | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 閉じる |
/done | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | To-Doアイテムを完了としてマークします。GitLab 16.2から導入されました。 |
/due <date> | {チェックサークル}はい | {点線円}いいえ | {チェックサークル}はい | 期限を設定します。有効な<date> の例には、in 2 days 、this Friday 、December 31st があります。 |
/health_status <value> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい |
健康状態を設定します。<value> の有効なオプションはon_track 、needs_attention 、またはat_risk です。 |
/label ~label1 ~label2 または/labels ~label1 ~label2
| {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | つ以上のラベルを追加します。ラベル名はチルダ (~ ) なしで始めることもできますが、混合構文はサポートされていません。 |
/promote_to <type> | {チェックサークル}はい | {点線円}いいえ | {チェックサークル}はい | 作業項目を指定されたタイプに昇格させます。<type> で利用可能なオプション:issue (タスクを昇格させる) またはobjective (キー結果を昇格させる)。GitLab 16.1 で導入されました。 |
/reassign @user1 @user2 | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 現在の担当者を指定した担当者に置き換えます。 |
/relabel ~label1 ~label2 | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 現在のラベルを指定したラベルに置き換えます。 |
/remove_due_date | {チェックサークル}はい | {点線円}いいえ | {チェックサークル}はい | 期日を削除します。 |
/reopen | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 再開 |
/shrug <comment> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | コメントを¯\_(ツ)_/¯ で追加します。 |
/tableflip <comment> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | コメントを(╯°□°)╯︵ ┻━┻ で追加します。 |
/title <new title> | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | タイトルを変更します。 |
/todo | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | To-Do項目を追加します。GitLab 16.2から導入されました。 |
/type | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | ワークアイテムを指定されたタイプに変換します。<type> で利用可能なオプションはissue ,task ,objective ,key result です。 GitLab 16.0 で導入されました。 |
/unassign @user1 @user2 | {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 特定の担当者を削除します。 |
/unassign | {点線円}いいえ | {チェックサークル}はい | {チェックサークル}はい | すべての担当者を削除します。 |
/unlabel ~label1 ~label2 または/remove_label ~label1 ~label2
| {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | 指定されたラベルを削除します。 |
/unlabel または/remove_label
| {チェックサークル}はい | {チェックサークル}はい | {チェックサークル}はい | すべてのラベルを削除します。 |
/weight <value> | {チェックサークル}はい | {点線円}いいえ | {点線円}いいえ | 重みを設定します。<value> で有効なオプシ ョ ンは0 、1 、2 です。 |
コミット・メッセージ
以下のクイックアクションはコミットメッセージに適用できます:
コマンド | アクション |
---|---|
/tag v1.2.3 <message> | オプションのメッセージとともにコミットにタグを付けます。 |
トラブルシューティング
クイックアクションが実行されない
クイックアクションを実行しても何も起こらない場合は、入力したクイックアクションがオートコンプリートボックスに表示されるかどうかを確認してください。表示されない場合は、以下の可能性があります:
- クイックアクションに関連する機能が、サブスクリプションの階層またはグループやプロジェクトでのユーザーロールに基づいて利用できない可能性があります。
- クイックアクションの必須条件が満たされていません。例えば、ラベルのないイシューに対して
/unlabel
。