Manual:Pywikibot/Gerrit

Terminology

Git - a version control system. Replaces SVN.
Gerrit - a code review platform (https://gerrit.wikimedia.org). Replaces Special:CodeReview
core - actual (master) branch formerly known as "rewrite".

For users

Git clients

Windows users: We recommend you use TortoiseGit with Git for Windows. It's recommended to install TortoiseGit first.
macOS/Linux: commandline git - https://git-scm.com/ or brew install git(Homebrew, macOS)
For example in order to download core via commandline:

$ git clone --recursive --branch stable https://gerrit.wikimedia.org/r/pywikibot/core.git

To update:

# Assuming you're already in "core":
$ git pull origin stable
$ git submodule update # Updates i18n messages

If you're lazy and want to be able to do that all at once, you can do:

# Assuming you're already in "core":
$ git pull origin stable --recurse-submodules # This updates everything

Note that the repositories are somewhat large (>100MB). If this is an issue, use

$ git clone --recursive --branch stable --depth 3 https://gerrit.wikimedia.org/r/pywikibot/core.git

to just retrieve the latest versions.

Using SVN

As of January 2024, it is no longer possible to use SVN to download Pywikibot. We suggest to use pip to install and update Pywikibot instead.

URLs

Your client will probably ask you for the repository url. The urls follow the format of: https://gerrit.wikimedia.org/r/pywikibot/[repo name].

So for core:

https://gerrit.wikimedia.org/r/pywikibot/core.

Nightly distributions

You can download the whole packages or browse the source code via download page in Toolforge

If you need more help on setting up your Pywikibot visit the #pywikibot IRC channel ^connect or pywikibot@ mailing list.

For developers

How to submit patches...configure git/gerrit. etc.

Read the guidelines, then follow steps in Gerrit/Getting started and run this:

#for hacking core
$ git clone --recursive ssh://USERNAME@gerrit.wikimedia.org:29418/pywikibot/core.git

and after modifying codes follow steps in Gerrit/Tutorial

Windows: Developer using Windows may also use Gerrit/TortoiseGit tutorial for further informations.

Example (step-by-step)

Do the following, step-by-step:

setup your software:
1. if not done already for svn access; create an SSH key, a developer account and add your public key to gerrit as well as to wikitech
2. install 'git' package
3. install 'git-review' package
  - the one by openstack [1], NOT the one by Facebook
  - any version like 1.12, 1.21, but NOT v1.18
clone and setup your repository:
1. clone the git repository with all submodules by using (like svn checkout)
```
$ git clone --recursive ssh://USERNAME@gerrit.wikimedia.org:29418/pywikibot/core.git pywikibot-git
```
  and wait, this step will take some time
2. enter the directory
```
$ cd pywikibot-git
```
3. config git setting for this repository/directory only (not global, in case e.g. you have different pseudo for multiple projects)
```
$ git config user.email "EMAIL"
```
  and
```
$ git config user.name "USERNAME"
```
  in order to configure this globally, use the --global parameter
4. config your terminal/console to output english messages (in order to work properly with git review, see Gerrit/git-review#Troubleshooting)
```
$ alias git="LANG=C git"
```
  this has to be done every time a new console is started, in order to configure this permanently, put this into your bashrc or similar setup file
5. setup git review for this repository only
```
$ git review -s
```
  and enter your USERNAME again, this is an important step - if you forget it, according to Gerrit/Tutorial#Push your change set to Gerrit, the final git review below (needed to commit your changes for review) will fail - though this can be still solved then
work with the repository, e.g. commit patches for review:
1. switch to the master branch (might not be needed)
```
$ git checkout master
```
2. update the current branch to revision online (like svn update)
```
$ git pull
```
3. create your own local temporary branch for working $ git checkout -b MEANINGFUL_BRANCH_NAME and try to choose a MEANINGFUL_BRANCH_NAME with the help of the branch naming tips available – the branch can be removed when not needed anymore with $ git branch -D MEANINGFUL_BRANCH_NAME
4. now write some code; see the Git commands add, rm and mv to add, remove or rename files - when you're ready go to the next step
5. commit your changes to your local temporary branch with
```
$ git commit --all
```
  (you can use -a instead of --all and -R instead of --no-rebase) and, as used from svn, enter a meaningful commit message, e.g. a short description of your code changes
  - See Gerrit/Commit message guidelines .
6. optionally check your changes by looking at the committed data
```
$ git show HEAD
```
  and make sure that you are sending what you wanted to
7. send the data to the online repository, resp. gerrit for review (like svn commit)
```
$ git review
```
8. finally go to Gerrit, click on your change and write a reviewer name in the input box near the "Add Reviewer" button
optionally/opt-in further settings:
- enable RCS keywords expansion (like svn:keywords $Id$ ) by using git hooks (explained in detail here - german only)
  - for core:
```
$ git config filter.rcs-keywords.smudge 'rcs-keywords.py %f'
```
```
$ git config filter.rcs-keywords.clean 'rcs-keywords.py'
```
  - (may be we should consider using the git-rcs-keywords module as mentioned in dealing-with-svn-keyword-expansion-with-git-svn)

Phabricator

Patches will be linked to a Phabricator task automatically if you mention 'Bug: T12345' in a line just before 'Change-Id: ....'. See Gerrit/Commit message guidelines for more information.

Problems, issues and work-a-rounds

jenkins-bot messages

https://integration.wikimedia.org/ci/job/pywikibot-core-tox-flake8/2591/console : FAILURE in ?s (non-voting)

The patchset committed did not pass flake8 code style checks. That says nothing about the functionality of the code but about the syntax and style.

https://integration.wikimedia.org/ci/job/pywikibot-core-tox-flake8-docstrings-mandatory/560/console : FAILURE in ?s (non-voting)

The patchset committed did not pass mandatory pep257 code style checks. That says nothing about the functionality of the code but about the inline documentation.

https://integration.wikimedia.org/ci/job/pywikibot-core-tox-nose/1448/console : FAILURE in ?s (non-voting)

The patchset committed did not pass pre-merge test suite. That indicates the code fails the basic tests, but a pass says nothing about the functionality of the modified code. There is a more extensive set of tests which developers should run pre-submission, and will run post merge.

This change could not be automatically merged with the current state of the repository. Please rebase your change and upload a new patchset.

The pachset cannot be merged automatically into current HEAD. Please consider Build failed due to merge conflict for a solution.

More info about this can be found in Gerrit/Tutorial#How to submit a patch and git review complains about multiple commits.