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".

Git clients

 * Windows users: We recommend you use [ https://tortoisegit.org/ TortoiseGit] with [ https://gitforwindows.org/ Git for Windows]. It's recommended to [ https://tortoisegit.org/support/faq/#install install TortoiseGit first.]

For example in order to download core via commandline:
 * macOS/Linux: commandline git - https://git-scm.com/ or brew install git(Homebrew, macOS)

To update:

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

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

to just retrieve the latest versions.

Using SVN
As of January 2023, it is still possible to use SVN to download Pywikibot. To do so, follow the instructions on Manual:Pywikibot/Installation/SVN.

Note however, that this will no longer work from January 2024. 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: .

So for core:

.

Nightly distributions
You can download the whole packages or browse the source code via [ https://pywikibot.toolforge.org/ download page in Toolforge]

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

Read the guidelines, then follow steps in and run this:

and after modifying codes follow steps in


 * Windows : Developer using Windows may also use for further informations.

Example (step-by-step)
Do the following, step-by-step:


 * 1) 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


 * 1) install ' git ' package


 * 1) install ' git-review ' package
 * 2) * the one by openstack, NOT the one by Facebook
 * 3) * any version like 1.12, 1.21, but NOT v1.18


 * 1) clone and setup your repository:


 * 1) clone the git repository with all submodules by using (like  )  and wait, this step will take some time


 * 1) enter the directory


 * 1) config git setting for this repository/directory only (not global, in case e.g. you have different pseudo for multiple projects)  and  in order to configure this globally, use the   parameter


 * 1) config your terminal/console to output english messages (in order to work properly with git review, see Gerrit/git-review#Troubleshooting)   this has to be done every time a new console is started, in order to configure this permanently, put this into your   or similar setup file


 * 1) setup git review for this repository only   and enter your   again, this is an important step - if you forget it, according to Gerrit/Tutorial#Push your change set to Gerrit, the final  below (needed to commit your changes for review) will fail - though this can be still solved then


 * 1) work with the repository, e.g. commit patches for review:


 * 1) switch to the master branch (might not be needed)


 * 1) update the current branch to revision online (like  )


 * 1) create your own local temporary branch for working  and try to choose a   with the help of the  available – the branch can be removed when not needed anymore with


 * 1) 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


 * 1) commit your changes to your local temporary branch with  (you can use  instead of  and  instead of  ) and, as used from svn, enter a meaningful commit message, e.g. a short description of your code changes
 * 1) * See.


 * 1) optionally check your changes by looking at the committed data  and make sure that you are sending what you wanted to


 * 1) send the data to the online repository, resp. gerrit for review (like  )


 * 1) finally go to [ https://gerrit.wikimedia.org Gerrit], click on your change and write a reviewer name in the input box near the "Add Reviewer" button


 * 1) optionally/opt-in further settings:


 * 1) * enable RCS keywords expansion (like svn:keywords ) by using git hooks (explained in detail [ https://github.com/progit/progit/blob/master/de/07-customizing-git/01-chapter7.markdown#schl%C3%BCsselworterweiterung here - german only])
 * 1) ** for core:
 * 2) ** (may be we should consider using the [ https://github.com/turon/git-rcs-keywords git-rcs-keywords module] as mentioned in [ https://stackoverflow.com/questions/62264/dealing-with-svn-keyword-expansion-with-git-svn/5633162#5633162 dealing-with-svn-keyword-expansion-with-git-svn])

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

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.