Webエディタ
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
Webエディタは、ローカル環境をセットアップしなくてもGitLabリポジトリを編集できるブラウザベースのツールです。次のことが可能です:
- 単一のファイルを編集し、Markdownのリアルタイムプレビューを表示する。
- 新しいファイルやディレクトリを作成する。
- ファイルをアップロード、置換する。
- バージョン管理用のブランチやタグを作成する。
- 同時編集の競合を防ぐためにファイルをロックする。
- Gitをローカルにセットアップせずに、プロジェクトにコントリビュートする。
GitLabは、Webエディタのコミットにプライマリメールアドレスを使用します。
複数のファイルを変更する場合は、Web IDEを使用します。
ファイルを管理する
GitLab UIから直接、Webエディタでファイルを作成、編集、アップロード、削除できます。
ファイルを作成する
Webエディタでテキストファイルを作成する手順は次のとおりです:
左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
新しいファイルを作成したいディレクトリに移動します。
ディレクトリ名の横にあるプラスアイコン( )> 新しいファイルを選択します。
ブランチ名の横に、ファイル名と拡張子を入力します。たとえば
my_file.mdと入力します。ファイルにコンテンツを追加します。
変更をコミットするを選択します。
コミットメッセージフィールドに、コミットの理由を入力します。
次のいずれかのオプションを選択します:
事前入力されたターゲットブランチにファイルを作成するには、変更をコミットするを選択します。
新しいブランチにファイルを作成して変更をコミットするには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオフになっていることを確認します。
- 変更をコミットするを選択します。
新しいブランチにファイルを作成し、変更をコミットし、マージリクエストを作成するには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオンになっていることを確認します。
- 変更をコミットするを選択します。
テンプレートから作成する
Webエディタでテンプレートからテキストファイルを作成する手順は次のとおりです:
- 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
- 新しいファイルを作成したいディレクトリに移動します。
- ディレクトリ名の横にあるプラスアイコン( )> 新しいファイルを選択します。
- ファイル名に、GitLabが標準で用意しているテンプレートの名を入力します:
.gitignore.gitlab-ci.ymlLICENSEDockerfile
- テンプレートを適用のドロップダウンリストから、テンプレートを選択します。
- オプション。必要に応じてテンプレートを更新します。
- ファイルを作成するのプロセスの手順6から続けます。
ファイルを編集する
Webエディタでテキストファイルを編集する手順は次のとおりです:
左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
編集したいファイルに移動します。
編集 > 単一のファイルを編集を選択します。
変更を加えます。
変更をコミットするを選択します。
コミットメッセージフィールドに、コミットの理由を入力します。
次のいずれかのオプションを選択します:
事前入力されたターゲットブランチからファイルを編集するには、変更をコミットするを選択します。
新しいブランチからファイルを編集し、変更をコミットするには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオフになっていることを確認します。
- 変更をコミットするを選択します。
新しいブランチからファイルを編集し、変更をコミットし、マージリクエストを作成するには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオンになっていることを確認します。
- 変更をコミットするを選択します。
- フィールドに入力し、マージリクエストを作成を選択します。
編集中に他のユーザーが同じファイルを編集して変更をコミットした場合、変更をコミットすることができません。Someone edited the file the same time you did. Please check out the file and make sure your change will not unintentionally remove theirs.(他のユーザーが同時にファイルを編集しました。ファイルをチェックアウトして、あなたの変更によって相手の変更が意図せず削除されないよう注意してください。)というエラーメッセージが表示されます。
Markdownプレビュー
WebエディタでMarkdownファイルをプレビューする手順は次のとおりです:
- 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
- プレビューしたいファイルに移動します。
- 編集 > 単一のファイルを編集を選択します。
- プレビュータブを選択します。
コンテンツとともにライブMarkdownプレビューを表示できます。
プレビューパネルを閉じるには、入力タブを選択します。
特定の行にリンクする
Webエディタ内の単一行または複数行にリンクするには、URLのファイル名部分にハッシュ情報を追加します。次に例を示します:
MY_FILE.js#L3は、MY_FILE.jsの3行目をハイライトします。MY_FILE.js#L3-10は、MY_FILE.jsの3行目から10行目をハイライトします。
ファイルを編集するときに、行番号を選択して単一行にリンクすることもできます。
フォークされたマージリクエストでファイルを編集する
前提要件:
- フォークからのマージリクエストを使って作業する必要があります。
- アップストリームメンバーからのコミットを許可する必要があります。
フォークされたプロジェクトからのマージリクエストを使って作業している場合は、ファイルを編集して変更をコミットできます。手順を次のとおりです:
- マージリクエストに移動します。
- 編集したいファイルに移動します。
- 編集 > 単一のファイルを編集を選択します。
- 変更をコミットするを選択します。
- コミットメッセージに、コミットの理由を入力します。次の情報が提供されます。
Your changes can be committed to <branch-name> because a merge request is open.(マージリクエストが開いているため、あなたの変更をにコミットできます。) - 変更をコミットするを選択します。
ファイルをアップロードする
Webエディタでファイルをアップロードする手順は次のとおりです:
左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
ファイルをアップロードするディレクトリに移動します。
ディレクトリ名の横にあるプラスアイコン( )> ファイルをアップロードを選択します。
追加したいファイルをドロップまたはアップロードします。
コミットメッセージフィールドに、コミットの理由を入力します。
次のいずれかのオプションを選択します:
事前入力されたターゲットブランチからファイルをアップロードするには、変更をコミットするを選択します。
新しいブランチからファイルをアップロードし、変更をコミットするには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオフになっていることを確認します。
- 変更をコミットするを選択します。
新しいブランチからファイルをアップロードし、変更をコミットし、マージリクエストを作成するには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオンになっていることを確認します。
- 変更をコミットするを選択します。
- フィールドに入力し、マージリクエストを作成を選択します。
ファイルを削除する
Webエディタでファイルを削除する手順は次のとおりです:
左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
削除したいファイルに移動します。
削除を選択します。
コミットメッセージに、コミットの理由を入力します。
次のオプションから選択します:
事前入力されたターゲットブランチからファイルを削除するには、変更をコミットするを選択します。
新しいブランチからファイルを削除し、変更をコミットするには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオフになっていることを確認します。
- 変更をコミットするを選択します。
新しいブランチからファイルを削除し、変更をコミットし、マージリクエストを作成するには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオンになっていることを確認します。
- 変更をコミットするを選択します。
編集中に他のユーザーが同じファイルを編集して変更をコミットした場合、変更をコミットすることができません。Someone edited the file the same time you did. Please check out the file and make sure your change will not unintentionally remove theirs.(他のユーザーが同時にファイルを編集しました。ファイルをチェックアウトして、あなたの変更によって相手の変更が意図せず削除されないよう注意してください。)というエラーメッセージが表示されます。
ファイルを置換する
Webエディタでファイルを置換する手順は次のとおりです:
左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
置換したいファイルに移動します。
置き換えるを選択します。
既存のファイルと置き換えたいファイルをドロップまたはアップロードします。
コミットメッセージに、コミットの理由を入力します。
次のオプションから選択します:
事前入力されたターゲットブランチからファイルを置換するには、変更をコミットするを選択します。
新しいブランチからファイルを置換し、変更をコミットするには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオフになっていることを確認します。
- 変更をコミットするを選択します。
新しいブランチからファイルを置換し、変更をコミットし、マージリクエストを作成するには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオンになっていることを確認します。
- 変更をコミットするを選択します。
ファイルへの変更をキャンセルする
Webエディタから、ファイルの変更、編集、アップロード、削除をキャンセルする手順は次のとおりです:
キャンセルを選択します。
次のいずれかを選択します:
- 確認して変更をキャンセルする場合: OKを選択します。
- 変更をキャンセルしない場合: キャンセルを選択します。
アクションメニューからのファイル操作
アクション( )メニューは、ファイル操作をドロップダウンリストにまとめています。このメニューから、次の操作を実行できます:
- ファイルを編集する。
- ファイルをアップロードする。
- ファイルを削除する。
- ファイルを置換する。
これらの操作を完了するには、次の手順に従います:
- GitLabでファイルを開きます。
- 右上隅にあるファイル名の横のアクション( )を選択します。
- 目的の操作を選択します。
ディレクトリを作成する
Webエディタでディレクトリを作成する手順は次のとおりです:
左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
新しいディレクトリを作成したいディレクトリに移動します。
ディレクトリ名の横にあるプラスアイコン( )> 新しいディレクトリを選択します。
ディレクトリ名フィールドに、ディレクトリ名を入力します。
コミットメッセージに、コミットの理由を入力します。
次のオプションから選択します:
事前入力されたターゲットブランチからディレクトリを作成するには、変更をコミットするを選択します。
新しいブランチからディレクトリを作成し、変更をコミットするには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオフになっていることを確認します。
- 変更をコミットするを選択します。
新しいブランチからディレクトリを作成し、変更をコミットし、マージリクエストを作成するには:
- 新しいブランチにコミットするを選択します。
- ブランチ名を入力します。
- この変更に対するマージリクエストを作成チェックボックスがオンになっていることを確認します。
- 変更をコミットするを選択します。
ブランチを作成する
Webエディタでブランチを作成する手順は次のとおりです:
- 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
- リポジトリ名の横にあるプラスアイコン( )> 新しいブランチを選択します。
- フィールドに入力します。
- ブランチを作成を選択します。
タグを作成する
タグを作成して、本番リリースやリリース候補などのマイルストーンをマークすることができます。Webエディタでタグを作成する手順は次のとおりです:
- 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
- リポジトリ名の横にあるプラスアイコン( )> 新しいタグを選択します。
- フィールドに入力します。
- タグを作成を選択します。