Skip to content

Commit

Permalink
Bump version, extend docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kmmbvnr committed Apr 15, 2011
1 parent 2f9eab8 commit 9c1506c
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 3 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ include LICENSE
include README.md
include MANIFEST.in
include django_jenkins/tasks/pylint.rc
include django_jenkins/tasks/jslint/fulljslint.js
recursive-include tests *
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,82 @@ reports.

For more details see the tutorial: http://sites.google.com/site/kmmbvnr/home/django-hudson-tutorial

Settings
--------

### `PROJECT_APPS`
if presents, it is supposed to be a white list of apps for jenkins run.
Tests, reports and coverage are generated only for the apps from this list.
You should specify --all option to ignore this settings.

### `JENKINS_TASKS`

List of jenkins tasks executed by ./manage.py jenkins command.

Default value:

JENKINS_TASKS = ('django_jenkins.tasks.run_pylint',
'django_jenkins.tasks.with_coverage',
'django_jenkins.tasks.django_tests',)

### `JENKINS_TEST_RUNNER`
The name of the class to use for starting the test suite for `jenkins` and `jtest` commands.
Class should be inherited from `django_jenkins.runner.CITestSuiteRunner`

Tasks
-----

Here is the list of tasks prebuild with django-jenkins

### `django_jenkins.tasks.run_pylint`

Runs pylint over selected django apps.

### `django_jenkins.tasks.with_coverage`

Produces xml coverage report for jenkinx

### `django_jenkins.tasks.django_tests`

Discovers standard django test suite from test.py files

### `django_jenkins.tasks.run_jslint`

Runs jslint tools over `app/static/*/*.js` files.
Creates pylint compatible report for jenkins

You should have `rhino` javascript interpreter installed for jslint

### `django_jenkins.tasks.run_pep8`

Runs pep8 tool over selected django apps.
Creates pylint compatible report for jenkins

You should have pep8 python package installed to run this tasks

### `django_jenkins.tasks.run_pyflakes`

Runs pyflakes tool over selected django apps.
Creates pylint compatible report for jenkins.

You should have pyflakes python package installed to run this tasks

### `django_jenkins.tasks.windmill_tests`

Discover windmill tests from app/wmtests.py files.
Each tests should be inherited from `django_jenkins.tasks.windmill_tests.WindmillTestCase`

You should have windmill python package installed to run this tasks

Changelog
-------
django-jenkins 0.11.0 2010-04-15

* Suuport pep8, pyflakes, jslint tools
* Added jtest command
* Allow specify custom test runner
* Various fixes, thnk githubbers :)

django-jenkins 0.10.0 2010-02-15

* Pluggable ci tasks refactoring
Expand Down
2 changes: 1 addition & 1 deletion django_jenkins/tasks/jslint
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/usr/bin/env python

from setuptools import setup, find_packages
from setuptools import setup

setup(
name = 'django-jenkins',
version = '0.10.0',
version = '0.11.0',
author = 'Mikhail Podgurskiy',
author_email = '[email protected]',
description = 'Plug and play continuous integration with django and jenkins',
Expand Down

0 comments on commit 9c1506c

Please sign in to comment.