Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #455 - Added documentation for modifying message replay mechanism #492

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,17 @@ Sending and Receiving Messages
Configuration
-------------

.. automodule:: fedmsg.config
:members: load_config, build_parser, execfile
For the list of configuration options, see the :ref:`conf` documentation.

.. autoclass:: fedmsg.config.FedmsgConfig

.. autodata:: fedmsg.config.conf

.. autofunction:: fedmsg.config.load_config

.. autofunction:: fedmsg.config.build_parser

.. autofunction:: fedmsg.config.execfile


.. _api-crypto:
Expand Down
69 changes: 69 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,75 @@
Changelog
=========

v1.1.1
======

Bug fixes
---------

* Fix a bug in the configuration validation for ``crl_cache_expiry`` and
``ca_cert_cache_expiry`` (`#500 <https://github.com/fedora-infra/fedmsg/pull/500>`_).

Developer improvements
----------------------

* Fix tests using the ``ca_cert_cache`` configuration as it is deprecated
(`#498 <https://github.com/fedora-infra/fedmsg/pull/498>`_).

* Adjust the internal ``_consume`` API for fedmsg consumers to return the
Return any return value from the parent class's ``_consume``
(`#507 <https://github.com/fedora-infra/fedmsg/pull/507>`_).

Contributors
------------

Thanks to all the contributors for this release:

* Sijis Aviles
* Ralph Bean
* Jeremy Cline


v1.1.0
======

Deprecations
------------

* Using URLs for the CA and CRL settings (``ca_cert_location`` and ``crl_location``
respectively) is now deprecated and will be removed in a future release. Please
use filesystem paths instead.

Features
--------

* Allow the CA and CRL configuration options to be file paths
(`#484 <https://github.com/fedora-infra/fedmsg/pull/484>`_).

* All configuration settings now have defaults and validators
(`#488 <https://github.com/fedora-infra/fedmsg/pull/488>`_).

* Strengthen "legacy protection" in fedmsg.meta by catching KeyErrors
(`#493 <https://github.com/fedora-infra/fedmsg/pull/493>`_).


Bug fixes
---------

* Remove the duplicate dependency on ``cryptography`` from the main install
requires (`#486 <https://github.com/fedora-infra/fedmsg/pull/486>`_).

* Adjust the x509 signing API to return text instead of bytes
(`#495 <https://github.com/fedora-infra/fedmsg/issues/495>`_).

Development improvements
------------------------

* Alter how the tests determine if cryptography is available to work better
with old versions of pyOpenSSL
(`#482 <https://github.com/fedora-infra/fedmsg/pull/482>`_).


1.0.1
=====

Expand Down
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@
# built documents.
#
# The short X.Y version.
version = u'1.0'
version = u'1.1'
# The full version, including alpha/beta/rc tags.
release = u'1.0.1'
release = u'1.1.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
Loading