Changelog
---------

0.17.4 (Mar 03, 2016)
^^^^^^^^^^^^^^^^^^^^^

- More robust handling of the project description element (see `issue 56`_).

- Added the ``verify-ssl``, ``cert-bundle``, and ``client-cert`` config-file
  options and the command-line switches to match them. These control the SSL
  certificate verification to the Jenkins server.

0.17.3 (Feb 10, 2016)
^^^^^^^^^^^^^^^^^^^^^

- Fix error-prone handling of the ``//project/description`` config.xml element
  (see `issue #54`_).

0.17.2 (Jan 21, 2016)
^^^^^^^^^^^^^^^^^^^^^

- Actually change the default tag method to ``description``. This was announced
  as the default behaviour in 0.17.0, but was accidentally omitted from that
  release (`issue #50`_).

Version 0.17.1 was skipped because of a failed upload to PyPi (see `issue #74`_).

0.17.0 (Oct 19, 2015)
^^^^^^^^^^^^^^^^^^^^^

- Jenkins-autojobs will now use the job description field to store its metadata.
  Expect to see ``(created by jenkins-autojobs)`` and ``(jenkins-autojobs-tag:
  $tagname [...])`` lines appended to the description of all managed jobs.

  This metadata was previously stored as elements in the job's ``config.xml``.
  Unfortunately, any manual reconfiguration of the job would cause Jenkins to
  remove these extra elements. This issue is described in greater detail in
  `issue #28`_. The old behavior can be kept by setting the ``tag-method``
  option to ``element``.

- Added the ``cleanup-filters`` configuration option, which filters the list of
  jobs that jenkins-autojobs considers for cleanup by view name or regular
  expression (thanks `@bartoszj`_). Example usage:

  .. code-block:: yaml

      # Cleanup only jobs in the 'Feature' and 'Release' views as well as all
      jobs that start with 'scratch'.
      cleanup-filters:
        views:
          - 'Feature'
          - 'Release'
        jobs:
          - '^scratch-.*'

- Added the ``list-closed`` option to the mercurial plugin, which controls the
  listing of closed branches. The old behaviour and current default value is
  ``true``. Note that this feature currently works only for local mercurial
  repositories.


0.16.2 (Oct 02, 2015)
^^^^^^^^^^^^^^^^^^^^^

- Fix accidentally introduced import error (thanks `@bartoszj`_).

0.16.1 (Sep 30, 2015)
^^^^^^^^^^^^^^^^^^^^^

- Fix cleanup functionality and improve performance (thanks `@bartoszj`_).

0.16.0 (Sep 23, 2015)
^^^^^^^^^^^^^^^^^^^^^

- Add the ``build-on-create`` option, which triggers a build when the job is
  created (thanks `@bartoszj`_).

- Ignore permission denied errors during job cleanup (thanks `@bartoszj`_).

- Fix issue with listing local mercurial branches (thanks `@Myz`_).

0.15.1 (May 05, 2015)
^^^^^^^^^^^^^^^^^^^^^

- The ``repo`` and ``repo-orig`` keys are now available to the
  ``namefmt`` and ``substitute`` options. They hold the sanitized and
  raw value of the ``repo`` top-level config key.

0.15.0 (Feb 16, 2015)
^^^^^^^^^^^^^^^^^^^^^

- The ``*`` wildcard can now be used in the ``branches`` config key of
  ``jenkins-makejobs-svn``. Example usage: ``file:///repo/projects/*/branches``.

0.14.3 (Jan 02, 2015)
^^^^^^^^^^^^^^^^^^^^^

- Fix sticky state when template job is enabled (thanks `@d-a-n`_ and
  `@sustmi`_).

0.14.2 (Nov 24, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Fix reading of scm-username and scm-password from stdin (thanks `@yamikuronue`_).

- Fix user input on Python 3.

- Fix typo that was preveneting jenkins-autojobs from working on
  Python 2.6 (thanks `@aklemp`_).

0.14.1 (Nov 23, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Ignore the 'All' view when adding jobs to views (thanks `@myz`_).

- View creation now respects the dryrun (-n) option (thanks `@aklemp`_).

- Fix reporting of view creation (thanks `@aklemp`_).

- Fix the httpdebug (-t) option on Python 3. The `httpdebug` option is
  now available in the config file.

0.14.0 (Oct 27, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Learn the ability to add generated jobs to specific views.

- Fix compatiblity with newer version of the Jenkins Mercurial plugin (thanks `@ThomasMatern`_).

0.13.1 (May 29, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Add the ``tag`` config option to the subversion script (thanks `@mrook`_).

0.13.0 (Apr 08, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Add the ``tag`` config option.

- The ``cleanup`` option now accepts a tag name.

- The ``substitute`` option now has access to matched groups (thanks `@traviscosgrave`_).

- The ``substitute`` and ``namefmt`` options can now refer to named capture groups. For example:

  .. code-block:: yaml

      refs:
        - 'refs/heads/feature-(\d\d)-(?P<name>\w+)-(\d)':
            namefmt: 'wip-{name}-{3}'

  The above ref config will map the branch ``feature-random-10`` to
  job ``wip-random-10``.

0.12.0 (Mar 09, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Fix a bug that made jenkins-autojobs remove all managed jobs if
  ``list_branches()`` failed with ``cleanup`` on (thanks `@sja`_).

- Use jenkins-webapi_ 0.2.0.

0.11.0 (Feb 04, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Add the ``cleanup`` config option (thanks `@timmipetit`_).

  If set to ``true``, jenkins-autojobs will remove all jobs for which
  a branch no longer exists.

- Jenkins-autojobs now adds a ``createdByJenkinsAutojobs`` element to
  the ``config.xml`` of jobs that it creates.

0.10.0 (Jan 08, 2014)
^^^^^^^^^^^^^^^^^^^^^

- Add the ``sanitize`` config option (thanks `@xgouchet`_).

  You can now substitute characters or whole patterns with the
  ``sanitize`` option:

  .. code-block:: yaml

      sanitize:
        '@!?#&|\^_$%*': '_'    # replace any of '@!?#&|\^_$%*' with '_'
        're:colou?r': 'color'  # replace regex 'colou?r' with 'color'

  The default is ``'@!?#&|\^_$%*': '_'``, which is the list of
  characters that are not allowed in job names.

0.9.1 (Jan 08, 2014)
^^^^^^^^^^^^^^^^^^^^

- Command line flags ``-u|-p`` properly overwrite ``username`` and
  ``password`` config keys (thanks `@timmipetit`_).

0.9.0 (Nov 27, 2013)
^^^^^^^^^^^^^^^^^^^^

- Add support for Python 3.x.

- Add the 'python' option to the mercurial yaml config. This sets the
  Python executable that will be used to call mercurial. This is
  useful when the default Python in ``PATH`` is not Python 2.x.

- Use jenkins-webapi_ instead of python-jenkins_.

0.6.0 (Sep 05, 2012)
^^^^^^^^^^^^^^^^^^^^

- Add mercurial support.

0.5.0 (Aug 06, 2012)
^^^^^^^^^^^^^^^^^^^^

*Initial Release*.

.. _jenkins-webapi: https://pypi.python.org/pypi/jenkins-webapi
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins

.. _`@timmipetit`:     https://github.com/timmipetit
.. _`@xgouchet`:       https://github.com/xgouchet
.. _`@sja`:            https://github.com/sja
.. _`@traviscosgrave`: https://github.com/traviscosgrave
.. _`@mrook`:          https://github.com/mrook
.. _`@ThomasMatern`:   https://github.com/ThomasMatern
.. _`@aklemp`:         https://github.com/aklemp
.. _`@myz`:            https://github.com/myz
.. _`@yamikuronue`:    https://github.com/yamikuronue
.. _`@d-a-n`:          https://github.com/d-a-n
.. _`@sustmi`:         https://github.com/sustmi
.. _`@bartoszj`:       https://github.com/bartoszj
.. _`@Myz`:            https://github.com/Myz

.. _`issue #28`:       https://github.com/gvalkov/jenkins-autojobs/issues/28
.. _`issue #50`:       https://github.com/gvalkov/jenkins-autojobs/issues/50
.. _`issue #54`:       https://github.com/gvalkov/jenkins-autojobs/issues/54
.. _`issue #56`:       https://github.com/gvalkov/jenkins-autojobs/issues/56

.. _`issue #74`:       https://github.com/pypa/packaging-problems/issues/74