devpi-jenkins 2.0.0

Installation

devpi-jenkins needs to be installed alongside devpi-server.

You can install it with:

pip install devpi-jenkins

For devpi-server there is no configuration needed, as it will automatically discover the plugin through calling hooks using the setuptools entry points mechanism.

Details about configuration below.

Configuration

devpi-jenkins can trigger Jenkins to test uploaded packages using tox. This needs configuration on two sides:

• devpi: configuring an index to send POST requests to Jenkins upon upload

• Jenkins: adding one or more jobs which can get triggered by devpi-jenkins.

# needs one Jenkins job for each name of uploaded packages
devpi index /testuser/dev uploadtrigger_jenkins=http://localhost:8080/job/{pkgname}/build

# one generic job for all uploaded packages
devpi index /testuser/dev uploadtrigger_jenkins=http://localhost:8080/job/multijob/build

Configuring Jenkins job(s)

On the Jenkins side, you need to configure one or more jobs which can be triggered by devpi-jenkins. Each job is configured in the same way:

• go to main Jenkins screen

• hit “New Job” and enter a name (“multijob” if you want to configure a generic job), then select “freey style software project”, hit OK.

• enable “This build is parametrized” and add a “File Parameter”, setting the file location to jobscript.py.

• add a buildstep “Execute Python script” (you need to have the Python plugin installed and enabled in Jenkins) and enter execfile("jobscript.py").

• hit “Save” for the new build job.

You can now devpi upload a package to an index and see Jenkins starting after the upload successfully returns.

Uploading Sphinx docs

If you have Sphinx-based documentation you can upload the rendered HTML documentation to your devpi server with the following command:

devpi upload --with-docs

This will build and upload Sphinx documentation by configuring and running this command:

setup.py build_sphinx -E --build-dir $BUILD_DIR \
         upload_docs --upload-dir $BUILD_DIR/html

If you have distutils configured to use a devpi index you can upload documentation to that index simply by executing:

python setup.py upload_docs

Once uploaded the documentation will be linked to from the index overview page. Documentation URLs have the following form:

http://$DEVPI_URL/$USER/$INDEX/$PACKAGE/$VERSION/+doc/index.html

The devpi upload --with-docs command may fail with the following error:

error: invalid command 'build_sphinx'

This probably means you’re using an old version of setuptools that doesn’t support the build_sphinx command used by devpi, so you need to update setuptools:

pip install -U setuptools

If the devpi upload --with-docs command still fails with the same error message, maybe you forgot to install Sphinx? In that case:

pip install sphinx

Bulk uploading release files

If you have a directory with existing package files:

devpi upload --from-dir PATH/TO/DIR

will recursively collect all archives files, register and upload them to our local testuser/dev pypi index.

Using plain setup.py for uploading

In order for setup.py to register releases and upload release files we need to configure our index server in the $HOME/.pypirc file:

# content of $HOME/.pypirc
[distutils]
index-servers = ...  # any other index servers you have
    dev

[dev]
repository: http://localhost:3141/testuser/dev/
username: testuser
password: <YOURPASSWORD>

Now let’s go to one of your setup.py based projects and issue:

python setup.py sdist upload -r dev

This will upload your sdist package to the testuser/dev index, configured in the .pypirc file.

If you now use testuser/dev for installation like this:

pip install -i http://localhost:3141/testuser/dev/+simple/ PKGNAME

You will install your package including any pypi-dependencies it might need, because the testuser/dev index inherits all packages from the pypi-mirroring root/pypi index.

2.0.0 - 2016-04-25

• Drop support for Python 2.6 [fschulze]

• fixes for devpi-server 3.0.0, older versions aren’t supported anymore [fschulze]

1.0.0 - 2015-05-13

• include version in testspec for devpi test command [fschulze]

• separated into plugin from devpi-server [fschulze (Florian Schulze)]