Commit 8c4fc0

2026-11-13 12:52:06 uddr: Gerrit over GitHub
Development/GerritBestPractices.md ..
@@ 1,34 1,40 @@
- # Useful tips and hints about using Gerrit
+ # Useful tips and hints about using Gerrit
For using https://gerrit.openvpn.net/ to submit and/or review OpenVPN 2.x patches. See [DeveloperDocumentation](../Development/DeveloperDocumentation) for how Gerrit is integrated in the Patch Submission workflow.
- ## Account Creation
+ ## Account Creation
- Please create your account [here](https://gerrit.openvpn.net/pwm/public/newuser).
+ Gerrit uses GitHub for login. To create an account, open https://gerrit.openvpn.net/, click **Sign in** and log in with your GitHub account. Your Gerrit account is created automatically on first login, and your GitHub login becomes your Gerrit username.
- ## Documentation
+ ## Documentation
Gerrit comes with extensive documentation. Before using it you should make yourself familiar at least with the basics in the [User Guide](https://gerrit.openvpn.net/Documentation/intro-user.html).
The rest of this page will assume that you have read the parts relevant to you and not generally repeat information covered there.
- ## Identity Settings
+ ## Identity Settings
Make sure you review the user settings for your account. At the very least make sure that
- * *Display Name* field is correct
- * you add all the email addresses which might appear in Author fields in Git commit
+ * your *Full Name* is correct. It is taken from the *Name* field of your GitHub profile and updated every time you log in, so set your name **on GitHub**.
+ If your GitHub profile has no name, Gerrit shows you as "Name of user not set" and you can enter your name in Gerrit under *Settings → Profile* instead.
+ * you add all the email addresses which might appear in Author fields in Git commits (*Settings → Email Addresses*). Only the public email of your GitHub profile is added automatically. Each new address has to be confirmed via a link Gerrit sends to it. Gerrit rejects uploads whose author or committer email is not registered on your account.
* you select your correct preferred email address
We might use this information to construct `Acked-by` statements when you review commits.
+ ## Git over SSH/HTTPS
+
+ Pushing and fetching over SSH: add your SSH public key under *Settings → SSH Keys*.
+
+ For Git over HTTPS, use a Gerrit HTTP token as the password: generate one under *Settings → HTTP Credentials*. The token is shown only once, so store it in your Git credential helper.
+
## Search / Menu settings
- Gerrit has a lot of options for creating search queries. You can find them in the [Documentation](https://gerrit.openvpn.net/Documentation/user-search.html). If you need a specific query regularly, you can
- add your own menu entry for yourself in your User Settings.
+ Gerrit has a lot of options for creating search queries. You can find them in the [Documentation](https://gerrit.openvpn.net/Documentation/user-search.html). If you need a specific query regularly, you can add your own menu entry for yourself in your User Settings.
Example query: `#/q/is:submittable+status:open+-inhashtag:mailsubmitted` lists all the changes that are submittable, not merged, and do not have the hashtag `mailsubmitted`. We use this to look for changes that ready to be sent to the mailing list.
- ## Submission to the mailing list
+ ## Submission to the mailing list
While we use Gerrit for code review, we currently do not merge commits directly in Gerrit. Instead we still use the openvpn-devel mailing list as the collection point for all patches. So if a commit has been reviewed in Gerrit and is ready for merge, it still needs to be sent as a patch to the mailing list. To simplify this task, a script is provided as `./dev-tools/gerrit-send-mail.py` that anyone can use to create an email to send to the list.
@@ 36,15 42,13 @@
Example usage:
- ```
$ ./dev-tools/gerrit-send-mail.py 374
https://gerrit.openvpn.net/changes/374?o=CURRENT_REVISION&o=LABELS&o=DETAILED_ACCOUNTS
- Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
+ Acked-by: Frank Lichtenheld frank@lichtenheld.com
https://gerrit.openvpn.net/changes/374/revisions/1/patch?download
send with:
git send-email --in-reply-to gerrit.1697649588000.I3ca6965799b23d542ababc3e38880317cb46a3ac@gerrit.openvpn.net gerrit-374-1.patch
$ git send-email --in-reply-to gerrit.1697649588000.I3ca6965799b23d542ababc3e38880317cb46a3ac@gerrit.openvpn.net gerrit-374-1.patch
- ```
Note that this assumes that the required configuration for git send-email is present in one of the standard git configuration files (`.git/config`, `~/.gitconfig`, etc).
@@ 52,7 56,7 @@
If you have submitted a patch to the list please set the `mailsubmitted` hashtag for that change to document this fact. This helps the maintainers to look for missing submissions.
- ## Gerrit notification mails
+ ## Gerrit notification mails
You can configure which Gerrit notification mails you want to receive in your User Settings.
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9