GitLab クイック アクション
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
クイック アクションは、GitLabの一般的なアクションに対するテキストベースのショートカットを提供します。クイック アクション:
- ユーザーインターフェースを使用せずに、一般的なアクションを実行します。
- イシュー、マージリクエスト、エピック、コミットの操作をサポートします。
- 説明またはコメントを保存すると、自動的に実行されます。
- 特定のコンテキストと条件に対応します。
- 別々の行に入力された複数のコマンドを処理します。
たとえば、クイックアクションを使用して、次のことができます:
- ユーザーを割り当てます。
- ラベルを追加します。
- 期限を設定します。
- 状態を変更します。
- その他の属性を設定します。
各コマンドはスラッシュ(/)で始まり、別の行に入力する必要があります。多くのクイック アクションはパラメーターを受け入れます。パラメーターは、引用符(")または特定の形式で入力できます。
パラメータ
多くのクイック アクションでは、パラメータが必要です。たとえば、/assign クイック アクションには、ユーザー名が必要です。GitLabは、利用可能な値のリストを提供することにより、ユーザーがパラメータを入力するのを支援するために、クイック アクションでオートコンプリート文字を使用します。
パラメータを手動で入力する場合は、次の文字のみが含まれている場合を除き、二重引用符(")で囲む必要があります:
- ASCII文字
- 数字 (0-9)
- アンダースコア (
_)、ハイフン (-)、疑問符 (?)、ドット (.)、アンパサンド (&) またはアットマーク (@)
パラメータは大文字と小文字が区別されます。オートコンプリートはこれを処理し、引用符の挿入を自動的に行います。
イシュー、マージリクエスト、エピック
次のクイックアクションは、説明、ディスカッション、スレッドに適用できます。一部のクイックアクションは、すべてのサブスクリプションプランで利用できるとは限りません。
| コマンド | イシュー | マージリクエスト | エピック | アクション |
|---|---|---|---|---|
/add_child <item> | 可 | 不可 | 可 | <item>を子アイテムとして追加します。<item>の値は、#item、group/project#item、またはアイテムへのURLの形式である必要があります。イシューでは、タスクとOKRを追加できます。イシューの新しい外観を有効にする必要があります。エピックでは、イシュー、タスク、OKRを追加できます。複数の作業アイテムを子アイテムとして同時に追加できます。 |
/add_contacts [contact:email1@example.com] [contact:email2@example.com] | 可 | 不可 | 不可 | 1つまたは複数のアクティブなCRM担当者を追加します。 |
/add_email email1 email2 | 可 | 不可 | 不可 | 最大6人のメール参加者を追加します。このアクションは、機能フラグissue_email_participantsの背後にあります。イシューテンプレートではサポートされていません。 |
/approve | 不可 | 可 | 不可 | マージリクエストを承認します。 |
/assign @user1 @user2 | 可 | 可 | 不可 | 1人以上のユーザーを割り当てます。 |
/assign me | 可 | 可 | 不可 | 自分自身を割り当てます。 |
/assign_reviewer @user1 @user2または/reviewer @user1 @user2 | 不可 | 可 | 不可 | 1人以上のユーザーをレビュアーとして割り当てます。 |
/assign_reviewer meまたは/reviewer me | 不可 | 可 | 不可 | 自分自身をレビュー担当者として割り当てます。 |
/blocked_by <item1> <item2> | 可 | 不可 | 可 | アイテムを他のアイテムによってブロックされているとしてマークします。<item>の値は、#item、group/project#item、または完全なURLの形式である必要があります。(GitLab 16.0で導入)。 |
/blocks <item1> <item2> | 可 | 不可 | 可 | アイテムを他のアイテムをブロックしているとしてマークします。<item>の値は、#item、group/project#item、または完全なURLの形式である必要があります。(GitLab 16.0で導入)。 |
/board_move ~column | 可 | 不可 | 不可 | イシューをボードの列に移動します。プロジェクトには、イシューボードが1つだけ必要です。 |
/clear_health_status | 可 | 不可 | 可 | ヘルスステータスをクリアします。 |
/clear_weight | 可 | 不可 | 不可 | ウェイトをクリアします。 |
/clone <path/to/group_or_project> [--with_notes] | 可 | 不可 | 可 | 指定されたグループまたはプロジェクトに作業アイテムのクローンを作成します。引数が指定されていない場合は、現在のグループまたはプロジェクトにクローンを作成します。ターゲットにラベル、マイルストーン、エピックなどの同等のオブジェクトが含まれている限り、可能な限り多くのデータをコピーします。--with_notesが引数として指定されていない限り、コメントまたはシステムノートはコピーしません。 |
/close | 可 | 可 | 可 | クローズ。 |
/confidential | 可 | 不可 | 可 | イシューまたはエピックを機密としてマークします。 |
/convert_to_ticket <email address> | 可 | 不可 | 不可 | イシューをサービスデスクチケットに変換します。GitLab 16.9で導入 |
/copy_metadata <!merge_request> | 可 | 可 | 不可 | プロジェクト内の別のマージリクエストからラベルとマイルストーンをコピーします。 |
/copy_metadata <#item> | 可 | 可 | 可 | プロジェクト内の別のアイテムからラベルとマイルストーンをコピーします。 |
/create_merge_request <branch name> | 可 | 不可 | 不可 | 現在のイシューから開始して、新しいマージリクエストを作成します。 |
/done | 可 | 可 | 可 | To Doアイテムを完了としてマークします。 |
/draft | 不可 | 可 | 不可 | ドラフトステータスを設定します。 |
/due <date> | 可 | 不可 | 可 | 期限を設定します。有効な<date>の例としては、in 2 days、this Friday、December 31stなどがあります。詳細については、Chronicを参照してください。 |
/duplicate <item> | 可 | 不可 | 可 | このアイテムをクローズし、<item>に関連付けられている、複製としてマークします。 |
/epic <epic>または/set_parent <epic> | 可 | 不可 | 可 | エピック<epic>に子アイテムとして追加します。<epic>の値は、&epic、#epic、group&epic、group#epic、またはエピックへのURLの形式である必要があります。 |
/estimate <time>または/estimate_time <time> | 可 | 可 | 可 | 時間見積もりを設定します。例: /estimate 1mo 2w 3d 4h 5m。詳細については、タイムトラッキングを参照してください。 |
/health_status <value> | 可 | 不可 | 可 | ヘルスステータスを設定します。<value>の有効なオプションは、on_track、needs_attention、at_riskです。 |
/iteration *iteration:<iteration ID> or <iteration name> | 可 | 不可 | 不可 | イテレーションを設定します。たとえば、Late in Julyイテレーションを設定するには、/iteration *iteration:"Late in July"を使用します。 |
/iteration [cadence:<iteration cadence ID> or <iteration cadence name>] <--current or --next> | 可 | 不可 | 不可 | イテレーションを、参照されるイテレーションケイデンスの現在または次に予定されているイテレーションに設定します。たとえば、/iteration [cadence:"Team cadence"] --currentは、イテレーションを「Team cadence」という名前のイテレーションケイデンスの現在のイテレーションに設定します。GitLab 16.9で導入されました。 |
/iteration <--current or --next> | 可 | 不可 | 不可 | グループに1つのイテレーションケイデンスがある場合、イテレーションを現在または次に予定されているイテレーションに設定します。たとえば、/iteration --currentは、イテレーションをイテレーションケイデンスの現在のイテレーションに設定します。GitLab 16.9で導入されました。 |
/label ~label1 ~label2または/labels ~label1 ~label2 | 可 | 可 | 可 | 1つまたは複数のラベルを追加します。ラベル名はチルダ(~)なしで開始することもできますが、混合構文はサポートされていません。 |
/link | 可 | 不可 | 不可 | インシデント内のリンクされたリソースにリンクと説明を追加します。 |
/lock | 可 | 可 | 可 | ディスカッションをロックします。 |
/merge | 不可 | 可 | 不可 | 変更をマージします。プロジェクトの設定によっては、パイプラインが成功したとき 、またはマージトレインに追加される場合があります。 |
/milestone %milestone | 可 | 可 | 不可 | マイルストーンを設定します。 |
/move <path/to/group_or_project> | 可 | 不可 | 可 | 作業アイテムを別のグループまたはプロジェクトに移動します。異なるアクセスルールがある場所へ作業アイテムを移動する際は注意してください。作業アイテムを移動する前に、機密データが含まれていないことを確認してください。 |
/page <policy name> | 可 | 不可 | 不可 | インシデントのエスカレーションを開始します。 |
/promote_to_incident | 可 | 不可 | 不可 | イシューをインシデントにプロモートします。新しいイシューを作成する際に、クイックアクションを使用することもできます。 |
/promote | 可 | 不可 | 不可 | イシューをエピックにプロモートします。イシューの新しい外観が有効になっている場合は、代わりに/promote_to epicを使用してください。 |
/publish | 可 | 不可 | 不可 | 関連付けられた状態ページにイシューを公開します。 |
/react :emoji: | 可 | 可 | 可 | 絵文字リアクションreaction>を切り替えます。GitLab 16.7で名前が変更されました。/award。/awardは、エイリアス化されたコマンドとして引き続き使用できます。 |
/ready | 不可 | 可 | 不可 | 準備完了ステータスを設定します。 |
/reassign @user1 @user2 | 可 | 可 | 不可 | 現在の担当者を、指定された担当者と置き換えます。 |
/reassign_reviewer @user1 @user2 | 不可 | 可 | 不可 | 現在のレビュー担当者を、指定されたレビュー担当者と置き換えます。 |
/rebase | 不可 | 可 | 不可 | ターゲットブランチの最新のコミットでソースブランチをリベースします。ヘルプについては、トラブルシューティング情報を参照してください。 |
/relabel ~label1 ~label2 | 可 | 可 | 可 | 現在のラベルを、指定されたラベルと置き換えます。 |
/relate <item1> <item2> | 可 | 不可 | 可 | アイテムを関連としてマークします。<item>の値は、#item、group/project#item、または完全なURLの形式である必要があります。 |
/remove_child <item> | 可 | 不可 | 可 | <item>を子アイテムとして削除します。<item>の値は、#item、group/project#item、またはアイテムへのURLの形式である必要があります。イシューの場合、イシューの新しい外観を有効にする必要があります。 |
/remove_contacts [contact:email1@example.com] [contact:email2@example.com] | 可 | 不可 | 不可 | 1つ以上のCRMコンタクトを削除します |
/remove_due_date | 可 | 不可 | 不可 | 期限date>を削除します。 |
/remove_email email1 email2 | 可 | 不可 | 不可 | 最大6人のメール参加者を削除します。このアクションは、機能フラグissue_email_participantsの背後にあります。イシューテンプレート、マージリクエスト、またはエピックではサポートされていません。 |
/remove_estimateまたは/remove_time_estimate | 可 | 可 | 可 | 時間の見積もりを削除します。 |
/remove_iteration | 可 | 不可 | 不可 | イテレーションを削除します。 |
/remove_milestone | 可 | 可 | 不可 | マイルストーンを削除します。 |
/remove_parent | 可 | 不可 | 可 | アイテムから親を削除します。イシューの場合、イシューの新しい外観を有効にする必要があります。 |
/remove_time_spent | 可 | 可 | 可 | 費やした時間を削除します。 |
/remove_zoom | 可 | 不可 | 不可 | このイシューからZoomミーティングを削除します。 |
/reopen | 可 | 可 | 可 | 再開します。 |
/request_review @user1 @user2 | 不可 | 可 | 不可 | 1人以上のユーザーに新しいレビューを割り当てるか、リクエストします。 |
/request_review me | 不可 | 可 | 不可 | 1人以上のユーザーに新しいレビューを割り当てるか、リクエストします。 |
/set_parent <item> | 可 | 不可 | 可 | 親アイテムを設定します。<item>の値は、#IID、参照、またはアイテムへのURLの形式である必要があります。イシューの場合、イシューの新しい外観を有効にする必要があります。 |
/severity <severity> | 可 | 不可 | 不可 | 重大度を設定します。イシューの種類はIncidentである必要があります。<severity>のオプションは、S1 … S4、critical、high、medium、low、unknownです。 |
/shrug | 可 | 可 | 可 | ¯\_(ツ)_/¯を追加します。 |
/spend <time> [<date>]または/spend_time <time> [<date>] | 可 | 可 | 可 | 費やした時間を追加または減算します。オプションで、時間が費やされた日付を指定します。たとえば、/spend 1mo 2w 3d 4h 5m 2018-08-26や/spend -1h 30mです。詳細については、タイムトラッキングを参照してください。 |
/status <value> | 可 | 不可 | 不可 | ステータスを設定します。<value>の有効なオプションには、ネームスペースに設定されたステータスオプションが含まれます。 |
/submit_review | 不可 | 可 | 不可 | 保留中のレビューを送信します。 |
/subscribe | 可 | 可 | 可 | 通知を購読します。 |
/tableflip | 可 | 可 | 可 | (╯°□°)╯︵ ┻━┻を追加します。 |
/target_branch <local branch name> | 不可 | 可 | 不可 | ターゲットブランチを設定します。 |
/timeline <timeline comment> | <date(YYYY-MM-DD)> <time(HH:MM)> | 可 | 不可 | 不可 | このインシデントにタイムラインイベントを追加します。たとえば/timeline DB load spiked | 2022-09-07 09:30などです。 |
/title <new title> | 可 | 可 | 可 | タイトルを変更します。 |
/todo | 可 | 可 | 可 | To Doアイテムを追加します。 |
/unapprove | 不可 | 可 | 不可 | マージリクエストを否認します。 |
/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 <item> | 可 | 不可 | 可 | 指定されたイシューとのリンクを削除します。<item>の値は、#item、group/project#item、または完全なURLの形式である必要があります。(GitLab 16.1で導入)。 |
/unlock | 可 | 可 | 可 | ディスカッションのロックを解除します。 |
/unsubscribe | 可 | 可 | 可 | 通知の登録を解除します。 |
/weight <value> | 可 | 不可 | 不可 | ウェイトを設定します。有効な値は、0、1、または2のような整数です。 |
/zoom <Zoom URL> | 可 | 不可 | 不可 | このイシューまたはインシデントにZoomミーティングを追加します。GitLab Premiumのユーザーは、インシデントにZoomリンクを追加する際に、簡単な説明を追加できます。 |
作業アイテム
GitLabの作業アイテムには、以下が含まれます:
次のクイックアクションは、作業アイテムの編集時またはコメント時に説明フィールドを通じて適用できます。
| コマンド | タスク | 目標 | 主な成果 | アクション |
|---|---|---|---|---|
/assign @user1 @user2 | 可 | 可 | 可 | 1人以上のユーザーを割り当てます。 |
/assign me | 可 | 可 | 可 | 自分自身を割り当てます。 |
/add_child <work_item> | 不可 | 可 | 不可 | <work_item>に子を追加します。<work_item>の値は、#item、group/project#item、または作業アイテムへのURLの形式である必要があります。複数の作業アイテムを子アイテムとして同時に追加できます。GitLab 16.5で導入。 |
/award :emoji: | 可 | 可 | 可 | 絵文字リアクションreaction>を切り替えます。GitLab 16.5で導入 |
/checkin_reminder <cadence> | 不可 | 可 | 不可 | チェックインリマインダーをスケジュールします。オプションは、weekly、twice-monthly、monthly、またはnever(デフォルト)です。導入 GitLab 16.4 (フラグ名はokrs_mvcとokr_checkin_reminders)。 |
/clear_health_status | 可 | 可 | 可 | ヘルスステータスをクリアします。 |
/clear_weight | 可 | 不可 | 不可 | ウェイトをクリアします。 |
/close | 可 | 可 | 可 | クローズ。 |
/confidential | 可 | 可 | 可 | GitLab 16.4に導入された作業アイテムを機密としてマークします。 |
/copy_metadata <work_item> | 可 | 可 | 可 | 同じネームスペース内の別の作業アイテムからラベルとマイルストーンをコピーします。<work_item>の値は、#itemの形式か、作業アイテムへのURLである必要があります。GitLab 17.9 で導入。 |
/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 | 可 | 可 | 可 | 1つまたは複数のラベルを追加します。ラベル名はチルダ(~)なしで開始することもできますが、混合構文はサポートされていません。 |
/promote_to <type> | 可 | 不可 | 可 | 作業アイテムを指定されたタイプにプロモートします。<type>で使用できるオプション:issue(タスクをプロモート)またはobjective(主な成果をプロモート)。GitLab 16.1で導入。 |
/reassign @user1 @user2 | 可 | 可 | 可 | 現在の担当者を、指定された担当者と置き換えます。 |
/relabel ~label1 ~label2 | 可 | 可 | 可 | 現在のラベルを、指定されたラベルと置き換えます。 |
/remove_due_date | 可 | 不可 | 可 | 期限date>を削除します。 |
/remove_child <work_item> | 不可 | 可 | 不可 | 子<work_item>を削除します。<work_item>の値は、#item、group/project#item、または作業アイテムへのURLの形式である必要があります。GitLab 16.10で導入。 |
/remove_parent | 可 | 不可 | 可 | 親作業アイテムを削除します。GitLab 16.9で導入されました。 |
/reopen | 可 | 可 | 可 | 再開します。 |
/set_parent <work_item> | 可 | 不可 | 可 | 親作業アイテムを<work_item>に設定します。<work_item>の値は、#item、group/project#item、または作業アイテムへのURLの形式である必要があります。GitLab 16.5で導入。GitLab 17.10で導入された新しいルックのイシューに対するエイリアス/epic。 |
/shrug | 可 | 可 | 可 | ¯\_(ツ)_/¯を追加します。 |
/status <value> | 可 | 不可 | 不可 | ステータスを設定します。<value>の有効なオプションには、ネームスペースに設定されたステータスオプションが含まれます。 |
/subscribe | 可 | 可 | 可 | 通知を購読します。GitLab 16.4で導入 |
/tableflip | 可 | 可 | 可 | (╯°□°)╯︵ ┻━┻を追加します。 |
/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 | 可 | 可 | 可 | すべてのラベルを削除します。 |
/unlink | 可 | 可 | 可 | 指定された作業アイテムへのリンクを削除します。<work item>の値は、#work_item、group/project#work_item、または完全な作業アイテムURLの形式である必要があります。GitLab 17.8 で導入。 |
/unsubscribe | 可 | 可 | 可 | 通知の登録を解除します。GitLab 16.4で導入 |
/weight <value> | 可 | 不可 | 不可 | ウェイトを設定します。<value>で使用できる有効なオプションは、0、1、2などです。 |
コミットのコメント
個々のコミットにコメントするときに、クイックアクションを使用できます。これらのクイックアクションは、コミットのコメントスレッドでのみ機能し、コミットメッセージやその他のGitLabコンテキストでは機能しません。
コミットのコメントでクイックアクションを使用するには:
- コミットリスト、マージリクエスト、またはその他のコミットリンクからコミットを選択して、コミットページに移動します。
- コミットページの下部にあるコメントフォームで、クイックアクションを入力します。
- コメントを選択します。
以下のクイックアクションは、コミットコメントに適用できます:
| コマンド | アクション |
|---|---|
/tag v1.2.3 <message> | コメントされたコミットを指すGitタグを、オプションのメッセージとともに作成します。 |
トラブルシューティング
クイック アクションが実行されない
クイック アクションを実行しても何も起こらない場合は、クイック アクションを入力時にオートコンプリートボックスに表示されるかどうかを確認してください。表示されない場合は、次の可能性があります。
- クイック アクションに関連する機能は、サブスクリプションプランまたはグループやプロジェクトのユーザーロールに基づいて使用できない可能性があります。
- クイック アクションに必要な条件が満たされていません。たとえば、ラベルのないイシューで
/unlabelを実行している場合などです。