Gerrit

From The Document Foundation Wiki
Jump to: navigation, search

このページはGlobal Wikiからの翻訳ページです。 未翻訳や内容が古い場合があります。古い場合は更新と翻訳のご協力をお願いします。 TDF Wikiには 日本語コミュニティによって運営されているページ もあります。WikiのURLがJAで始まるカテゴリーがJAのページです。そちらもご利用ください。

注意:このページのオリジナルは英語版 Gerrit2017-03-25T00:40:28 の版からコピーしたものです。

原文は逐次改定されるので、定期的に原文を参照して差分を更新し、ずれることがないようにお願いします。なお差分更新をかけた場合は上の日付も修正しておいてください。

このページはコードの査読ツールgerrit.libreoffice.orgと、LibreOffice中でのその使い方のエントリーページです。

Gerritのセットアップ

このページはGlobal Wikiからの翻訳ページです。 未翻訳や内容が古い場合があります。古い場合は更新と翻訳のご協力をお願いします。 TDF Wikiには 日本語コミュニティによって運営されているページ もあります。WikiのURLがJAで始まるカテゴリーがJAのページです。そちらもご利用ください。


Setting yourself up for gerrit

Before you start: Troubleshooting help

The instructions below should be easy and quick to follow. However, if you get stuck somewhere, here is how you get help:

Register in Gerrit for first time

Gerrit uses The Document Foundation's Single-On service for authentication. Create an account there if you don't have one already (several other sites, such as this wiki, use it too). Then simply launch gerrit and click on the “Sign in” link at the top right of the page. You'll be redirected to our central authentication portal, and then back to Gerrit once authenticated.

Setting yourself up for gerrit - the easy way

If you have a checkout of libreoffice/core already, you can just run ./logerrit setup, which will try to automatically setup keys and configure ssh for you, and if it can't it will guide you through these steps: if necessary, just follow the steps.

The program will tell you to go to https://gerrit.libreoffice.org, click Register and remember your username. The program will also generate a public SSH key, print it and save it to /home/[username]/.ssh/id_rsa.pub. This key will begin with 'ssh-rsa'. You must enter this key during the registration process on the website (or add it later in SSH Public Keys under Settings in order for gerrit to work.

If ./logerrit test fails and ssh -vvv logerrit informs you about ~/.ssh/config having bad permissions, run chmod 600 config in ~/.ssh.

Detailed and nitty-gritty setup topics

Setting yourself up for gerrit - the manual way

  1. Create an account at https://gerrit.libreoffice.org
  2. You must set your username in your gerrit account settings). Users are associated by username and SSH key. This username is referred to as YOUR_USERNAME_HERE below.
  3. Generate an SSH keypair for gerrit and upload the public key in the preferences (of course you can also reuse an existing key)
  4. Add the following to your ${HOME}/.ssh/config (both sections are identical except for the "Host" line):
     Host logerrit gerrit.libreoffice.org
           IdentityFile /path/to/your/private-key
           User YOUR_USERNAME_HERE (cf. above)
           Port 29418
           HostName gerrit.libreoffice.org
    

    Note that /path/to/your/private-key must include the file name as well. For example: ~/.ssh/id_rsa

  5. Setup your git repo so that it pushes to gerrit using the SSH key:
    git config remote.origin.pushurl ssh://logerrit/core
    
  6. and you are ready to go!

Now push !

See: How to submit patches

ほかの方法は、手動で細かく設定するアプローチです。その詳細は Development/gerrit/setup/ja にあります。

Gerritへのパッチの送信

貢献者リストにあなたを追加する

もし初めてLibreOfficeプロジェクトにパッチを送るのであれば、開発者と貢献者リストにあなたを追加し(そこの指示に従ってください)、あなたの貢献のライセンスを表明してください。

査読用パッチの送信

それでは、変更点(パッチ)を作成し、査読のためにgerritに送信してください(公式gerritドキュメントはこちら):

git checkout -b <a_local_branch_name_of_your_choice>
# コードを変更して、それがビルドできることを確認してください
git add file [file ...] # 新しいファイル _と_ 変更したファイルを全て
git commit
./logerrit submit master

注意:`logerrit`コマンドが動くようにするため、確実にgerritのセットアップをしてください。 ガイドはここにあります。

注意: git add + git commit ステップは'git gui'でも行うことができますが、コミットの題名行は65文字以下で、(もしあれば)コミットメッセージ行は70文字以下であることに注意してください。

注意:masterへの投稿において、現在のmasterのバージョンでの変更の(リ)ベースは有用です。これによってjenkins上でのCIビルドでccacheの恩恵を多く受けることができます。

少なくとも最後の行は特別で、この行で名前付きローカルブランチのすべてのパッチが、査読キューのmasterブランチにpushされます(リリースブランチやほかのブランチに送信したいならば適宜修正してください)。普通の貢献者はパッチのメールアドレスがgerritアカウントと同一でないとpushが許可されません。

pushに成功したら、gitはあなたのコミットが査読待ちのどこにいるのかを報告します。URLは以下のようなものになります: https://gerrit.libreoffice.org/#/c/229/.

査読中はローカルブランチを保持したままのほうが良いでしょう。それによって、パッチの新しいバージョンを簡単にpushできるようになります。 その間は以下のコードを実行することで In the mean time you can

git checkout master

masterブランチに戻ることができます - そして上記の操作(ローカルブランチの作成、コーディング、コミット、gerritへのpush)でほかのパッチを再び編集することができます。

パッチ送信の追加情報

上記の方法の代わりに、Development/GitReviewでの説明の通り、"git review"を使うこともできます。


Development/gerrit/SubmitPatch/jaに以下のような話題があります:

  • 新しいバージョンの送信
  • 下書きとしてのパッチの送信

Development/Submodulesに以下のようなサブモジュールへのパッチ送信に関する話題があります:

  • 辞書
  • helpcontent2 (for help files)
  • 翻訳

Gerritの追加情報

追加情報