Gerrit/Tutorial/ja

このチュートリアルは、Gerrit で変更点を作成/変更するために Git を使用する方法を説明するものです.


 * For reference documentation on specific tasks, check instead.
 * Gerrit を試したいだけで、「実際の」ウィキメディア ソフトウェア プロジェクトのパッチを書きたいわけではない場合は、代わりに Gerrit テスト インスタンスを使用してください.

このチュートリアルでは、入力するコマンドは以下のようにドル記号 ($) で始まります:. 接頭辞は入力しないでください. コマンドに、自分で変更する必要がある変数も含まれている場合、変数は赤で表示されます:.



Git とは
Gitは、無料でオープンソースの分散型バージョン管理システムです. 「分散」は、リポジトリの中央管理コピーがないことを意味します. Git では、リポジトリのクローンを作成すると、ソースコードの完全に機能するコピーが、すべてのブランチとタグ付きリリースを含めてダウンロードされます.



ウィキメディア開発者アカウントの作成
ウィキメディア開発者アカウントをまだお持ちではない場合は、アカウントを作成してください. 同じ利用者名とパスワードが、下記の Gerrit へのログインでも使用されます.



Git をセットアップする
これらの手順では、Git をコマンド ライン (ターミナル ウィンドウ) ツールとしてインストールする方法を説明します. コマンド ラインではなくグラフィカル ユーザー インターフェイス (GUI) を使用したい場合は、Git プロジェクトが管理しているクライアント一覧を確認してください. 別のインストール手順については、公式の説明文書を参照してください.

インストール
Follow Installing Git to learn how to install git on your operating system.



Gitの設定
さてGitがインストールされて、個人情報を設定する時間です. 1回だけはこれを行う必要があります. これらのコマンドを再度実行することによって、いつでも個人情報を変更することもできます.

Gitは利用者の名前とメールをチェックすることによって、各々のコミットを誰が行ったのか追跡します. さらに、この情報はあなたのコミットをあなたのGerritアカウントと関連付けるために使われます.

以下の2つのコマンドを入力して、あなたの利用者名とメールアドレスを設定してください. を自分自身のGerrit利用者名で置き換え、を自分自身のメールアドレスで置き換えてください：



GerritでSSH鍵をセットアップする
あなたのコンピュータとGerritの間に安全な接続を確立するために、SSH鍵を使います. 2021年8月現在、ウィキメディアセキュリティチームは、最適なセキュリティとパフォーマンスのために、利用者がSSH鍵の作成に タイプを使うことを推奨します.



SSH鍵を取得する
Follow SSH keys.



SSH公開鍵をGerritアカウントに追加する

 * Gerritのウェブインターフェースにログインします. Gerritの利用者名とパスワードは、ウィキメディア開発者アカウントと同一です.
 * 右上隅にあるユーザー名をクリックし、「設定」を選択します.
 * 左側のメニューで「SSHキー」をクリックします.
 * SSH公開鍵を対応する欄に貼り付けて、 "ADD NEW SSH KEY"をクリックしてください.



Gerrit SSHの接続をテストする
経由でGerritサーバーに接続し、すべてが期待どおりに動作しているかどうかを確認します. Replace by your shell username as shown in your Gerrit settings:



Gerrit SSH接続成功メッセージの例はこのようになります：
 * Be mindful and compare that the "ed25519 key fingerprint" is the same as the SSH fingerprint for gerrit.wikimedia.org:29418. If it is the same, answer "Yes" to "Are you sure you want to continue connecting?". Then enter the passphrase for your key.
 * You should get a message "Welcome to Gerrit Code Review". The last line should show "Connection to gerrit.wikimedia.org closed."
 * If you run into problems, use (replace  by your username).  は問題を見つけるのを手助けするために冗長出力を提供します.  それからGerritトラブルシューティングを読んでください.



サンドボックス
Gerrit の使用法を練習したい場合は、このチュートリアルが使用している「sandbox」というリポジトリをダウンロード (「クローン」とも言います) してください.

以下をGit Bashコマンドラインで実行します：

(Replace by your Gerrit username.  And make sure the URL begins with   and not  ).

This will copy the entire history and the code base of the "sandbox" extension repository into your machine. You will have a working directory of the extension's main branch (usually also called "git master"). Enter the new directory (via the command ). Now you can look at the code and start editing it.



既存のリポジトリ
Cloning the Sandbox repository will not give you a development environment setup or a running MediaWiki installation. (Running will require MediaWiki Core and placing the code you checked out in a location expected by your web server.) See Download from Git for how to download MediaWiki Core, extensions, skins, or any other project repository hosted at gerrit.wikimedia.org from Git.

Vagrant
Vagrant を使用して MediaWiki や拡張機能をダウンロードした場合、Git が HTTPS ではなく SSH を使用してコードをプッシュするように構成されていることを確認してください.



Gerritで作業する準備
Gerrit requires that your commit message must have a "change ID". それらはI（iの大文字）で始まる のようなものです. Each time you amend a commit to improve an existing patch in Gerrit, this change ID stays the same, so Gerrit understands it as a new "patch set" to address the same code change.

There's a git add-on called git-review that adds a Change-ID line to your commits. Using git-review is recommended. It makes it easier to configure your Git clone, to submit a change or to fetch an existing one.



git-review のインストール
ウィキメディア Gerritは、git-review バージョン1.27以降を必要とすることに注意してください.

詳細は、Gerrit/git-review#インストールを参照してください.

Font Awesome 5 brands linux.svg Linux

 * Linuxディストリビューションのグラフィカルソフトウェアパッケージ管理ツールを使用して、 パッケージをインストールします.
 * git-reviewがディストリビューションにパッケージ化されていない場合は、pip Pythonパッケージインストーラーを使ってgit-reviewをインストールするなどのその他のオプションをgit-reviewで確認してください.
 * FreeBSDを使っているならば、portsでgit-reviewをインストールしてください.

Font Awesome 5 brands windows.svg Windows

 * git-review Windowsを参照してください.

Apple logo black.svg macOS

 * For OS X 10.11 El Capitan and later, follow Method 1.
 * On versions prior to 10.11, use the pip Python package installer by following Method 2.



git-reviewを設定する
Gitのデフォルトのリモートホスト名は"origin"です. この名前はウィキメディアプロジェクトでも使われます. git-reviewにそのホストを使うように教える必要があります. をあなたのGerrit利用者名で置き換えてください：



git-reviewをセットアップする
リポジトリをダウンロード（「クローン」）した後、git-reviewのためにセットアップする必要があります. This will automatically happen the first time you try to submit a commit, but it's generally better to do it right after cloning. Make sure that you are in the directory of the project that you cloned (otherwise you will get an error "fatal: Not a git repository"). それからこのコマンドを実行してください：

出力の最後の方に、このようなものが表示されるはずです：

使用しているシェルのユーザー名と異なる場合、これはgitのユーザー名を尋ねるかもしれません.

By default  uses the branch. If the repo you're working on uses another branch, e.g., you need to set the config variable. This can be done with the following command (where  is the branch name):



パッチを投稿する
あなたが関心のあるコードリポジトリをクローンしたことを確かめてください（上述のGitを使ってコードをダウンロードするを参照）.

コードリポジトリのディレクトリにいることを確かめてください（コマンドはあなたがどこにいるのか正確に教えてくれます）.

Update the main development branch
Make sure that the main development branch (the branch created when you initially cloned the repository) is up to date:

However, note that some repositories use a different name for their main development branch (for example  instead of , or the   repository has a   instead of a   branch).



ブランチの作成
まず、あなたの新しい変更についてローカルブランチを作成します. 以下のを短いけれど適度に説明的な名前で置き換えます. （例えば、あなたの変更に対応するのタスクが存在するならば としたり、 、あるいは ）. 他の人たちもあなたのブランチを識別するために、この名前を使用します.

This will create a new branch (called ) from the latest 'master' and check it out for you. 上記の例では、新しいブランチを と呼びます.

<span id="Make_your_changes">

変更を行う
ローカルのコードに変更を行います. 好きなテキストエディタを使ってファイルを修正してください. 以下の例では、ファイル を編集して単語を追加しています.

それからテキストエディタを閉じて、ファイルやディレクトリの中で、最後のコミット以降にあなたが行った変更をチェックしてください：

はあなたの変更をユニファイド形式 (Unified format)で表示します：除去された行はマイナス から始まり、追加された行はプラス  から始まります. これらの変更はまだ次のコミットのために（ によって）「ステージ」されていません.

<span id="Stage_your_changes_for_a_commit">

変更をコミットするためにステージする
どの変更をあなたのコミットに組み込むべきか決定するために、を実行してください. これによりディレクトリの中であなたが変更したファイルの一覧が表示されます. この時点では、出力の最後の行に "no changes added to commit"（コミットに変更が追加されていません）と表示されます.

あなたの変更したファイルを次のあなたのコミットに組み込むには を使用してください. 上記の例ではファイル を修正しましたので、コマンドは以下のようになります：

に渡していないあらゆる変更したファイルは、次のステップで を実行するときに無視されます.

<span id="Commit_your_staged_changes">

ステージした変更をコミットする
によって追加した変更の一覧に満足したら、以下を使用することでこれらの変更をローカルリポジトリにコミットすることができます

その後テキストエディタであなたのコミットに対する説明的な要約を追加するように求められます. コミット メッセージの指針に従わなければなりません. これはコードリポジトリの変更履歴を見るときに、他の人たちが参照するものです.

コミットメッセージを保存してテキストエディタを閉じてください. A summary (the commit ID, your subject line, the files and lines changed) will be displayed.

<span id="Prepare_to_push_your_commit_to_Gerrit">

Gerritへコミットをプッシュする準備
Synchronise your changeset with any changes that may have occurred in the master branch while you've been working ("rebasing"). From within your branch, run:

さてレビューのためにGerritへコードをプッシュする準備ができました. もし関連するコミットを複数回行っていたならば、 レビューのためにそれらを単一のコミットにマージすることを検討してください.

<span id="Push_your_commit_to_Gerrit">

Gerritへコミットをプッシュする
If you followed #Prepare to work with Gerrit above and installed  and ran , then the command to push changes to Gerrit is:

The  option tells git-review not to perform a rebase before submitting the change to Gerrit.

Upon success, you'll get a confirmation and a link to the changeset in Gerrit. In the example above, that link is: https://gerrit.wikimedia.org/r/#/c/sandbox/+/563720

Congratulations! Your patch is in Gerrit and hopefully will get reviewed soon!

If git review -R fails
If you are asked to enter your git credentials (a username and password) after running and it responds that they are invalid, it's likely that the repo was cloned using https and not ssh. You should not recieve any prompt to enter credentials if you are using ssh. To switch the repo to ssh, run and replace  with the one found in gitiles that begins with. Make sure to add your Gerrit username before. For example, the repository URL for the Echo repository would be.

If you get a, re-follow the instructions at  to make sure your ssh agent is running and your identity is added. If you close your Git Bash shell, you will be signed out and need to re-follow these instructions each time.

View the Change / Next Steps
Open the link to your Gerrit changeset in a web browser.

Under "Files", after you clicked the down arrow at the very right of any file in the list, you can see a diff of your changes per file: The old lines are shown in red color and your new lines are shown in green color.

If your commit addresses a ticket in Phabricator, a comment will be automatically added in the Phabricator task if you followed the Commit message guidelines. If you did not, you could either fix your commit message (by creating an updated patchset), or manually add a comment on that Phabricator ticket which includes a link to your changeset in Gerrit.

<span id="Other_common_situations">

その他のよくある状況
もしあなたの状況がここで取り扱われていなければ、Gerritの高度な使用法も参照してください.

Squash several commits into one single commit via rebase
If you made several related commits to your local repository prior to wanting to submit for review, you should squash (merge) those commits into one single commit.

The  or   option allows you to change (rewrite) your commit history. For each commit, you can modify and change the commit message, add or remove files, or perform other modifications.

First you need to tell git how far back you want to pull. To get a list of all changes in your branch:

You can also limit the displayed list of recent changes. means pull the last three commits:

After you type this command, your text editor will display your commits in reverse order and a list of available commands:

Since we only want to send one commit to review, we will squash the last two commits into the first. Hence change all but the first "pick" to "squash":

pick aa8cf1d Adding method customFilterFunctionGetRiskyCountryCodeScore to GatewayAdapter. squash 38828e2 Adding $wgDonationInterfaceCustomFiltersFunctionsRiskyCountries to donationinterface.php squash be33007 Fix a typo

When you finished picking and squashing and saved the file, another file will open in your text editor to allow you get to edit and merge your commit messages. Be careful to only keep one of the Change-Id lines and have it be at bottom of the message after one empty line.

Your messages from your previous commits will automatically be placed in this message:

Remember to put your (updated) summary message in the commit. In this case the new summary message will be:

(mingle-fr-2012-69) Adding a custom filter for risky countries.

If all goes well, you should see a successful rebase message:

Afterwards, submit your patch for review:

You should see a message like this showing your git review went to Gerrit (in this example, to https://gerrit.wikimedia.org/r/7187):

Amending a change (your own or someone else's)
Sometimes, you might need to amend a submitted change. You can amend a change as long as the change hasn't been merged yet.

You can amend your own changes. To amend changes submitted by someone else, you need to be a member of Gerrit's Trusted-Contributors group. To become a member of Trusted-Contributors, find someone who is a member and ask them to add you. The group is viral in that members can add new members, use your powers responsibly.

Rebasing
Rebase to bring your local branch up to date with the remote. It's best to make rebase updates a separate patch, so that your code reviewers have an easy time seeing what changes you've made. Assuming you are using Gerrit, you can do this by clicking the "Rebase Change" button when viewing your patch in Gerrit's web interface.

Hard reset and checkout the change with this command: (BEWARE:  performs a hard reset that destroys all local changes. Stash or commit changes first which you wish to preserve!)

例:

You can look in Gerrit to figure out the. It is the six digit number in the URL of your code review page.

Or, if you already have the change in a branch on your local repository, you can just check it out:

例:

Make changes and push
次に、好きなテキストエディタで何らかの変更を行います.

the files as needed, then commit the change (ensuring you are amending the commit):

変更をプッシュします：

ここでは が重要です. It tells git-review to not rebase your change against master, which clutters diffs between patch set 1 and 2.

<span id="Push_to_a_branch_different_than_master">

master以外のブランチにプッシュする
上記では、コミットはmasterブランチにプッシュされていました. The branch name only appeared as the topic of the commit in the Gerrit UI. もし本当にmasterとは異なるブランチにプッシュしたいのであれば、 でプッシュする必要があります.

トラブルシューティング
問題とその解決方法については、を参照してください.

<span id="See_also">

関連項目
これらのページも有用です：


 * Gerrit チュートリアル tl;dr
 * Gerrit TortoiseGit チュートリアル
 * Wikimedia Gerrit Patch Uploader
 * Gerrit チュートリアル tl;dr
 * Gerrit TortoiseGit チュートリアル
 * Wikimedia Gerrit Patch Uploader