From c30082efac188f3e48fca6f3a155bfa2b3d6f9e9 Mon Sep 17 00:00:00 2001 From: Dan Callaghan Date: Jun 26 2018 23:55:29 +0000 Subject: [PATCH 1/3] docs: add missing reference to #137 in release notes --- diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 37cf294..fc679e6 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -21,9 +21,9 @@ Next Release not work in all cases. * Previously, when you requested a list of waivers, WaiverDB would consider - waivers from unrelated users and product versions to obsolete each other. The - API now correctly returns the most recent waiver from each user, and for each - product version. + waivers from unrelated users and product versions to obsolete each other + (#137). The API now correctly returns the most recent waiver from each user, + and for each product version. * The documentation now includes a section describing how end users can submit waivers using the command-line interface (see :ref:`user-guide`, #149). From 509cacabc6bb411fed1bcc215e0c9cb2fa5fdd5e Mon Sep 17 00:00:00 2001 From: Dan Callaghan Date: Jun 26 2018 23:55:29 +0000 Subject: [PATCH 2/3] docs: add intersphinx config for linking to Greenwave docs Also switched to using Python 3 intersphinx instead of Python 2, and updated to the "new" (Sphinx 1.0+) config style with explicitly named project keys. --- diff --git a/docs/conf.py b/docs/conf.py index 06d05b8..caa667b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -190,9 +190,10 @@ epub_copyright = copyright # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/2/': 'python-intersphinx.inv'} +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', 'python-intersphinx.inv'), + 'greenwave': ('https://docs.pagure.org/greenwave/', 'greenwave-intersphinx.inv'), +} # Configuration for issue tracker magic linking. issuetracker = None diff --git a/docs/greenwave-intersphinx.inv b/docs/greenwave-intersphinx.inv new file mode 100644 index 0000000..0b61a23 Binary files /dev/null and b/docs/greenwave-intersphinx.inv differ From 17778ae3373cf7a3babd36d22cf2e6ab3cdb8279 Mon Sep 17 00:00:00 2001 From: Dan Callaghan Date: Jun 27 2018 00:14:41 +0000 Subject: [PATCH 3/3] docs: add more detailed release note about subject_type changes --- diff --git a/docs/release-notes.rst b/docs/release-notes.rst index fc679e6..e41e1c8 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,15 +5,32 @@ Release Notes Next Release ============ +* Waivers now have two new attributes, ``subject_type`` and + ``subject_identifier``, to identify the subject of the waiver (that is, the + particular software artifact that the waiver is about). These new attributes + replace the ``subject`` attribute which is now deprecated. + + The ``subject`` attribute previously accepted any arbitrary key-values, but + in practice the ``subject`` had to conform to one of several recognized + structures in order to be usable with Greenwave. This has now been made + explicit with the ``subject_type`` attribute. + See :ref:`greenwave:subject-types` in the Greenwave documentation for a list + of possible subject types and the meaning of their corresponding identifiers. + See `Greenwave issue 126 `_ for more + background about this change. + + For backwards compatibility the ``subject`` attribute is still included when + fetching waivers, and accepted when creating waivers. However if you create + a new waiver using the deprecated ``subject`` attribute, its structure must + match one of the recognized subject types, otherwise the request will fail + with 400 status code. In this release we have implemented support for all + known subject types in the wild. + * New endpoint :http:post:`/api/v1.0/waivers/+filtered` deprecates :http:post:`/api/v1.0/waivers/+by-subjects-and-testcases`. This allows posting an arbitrary set of filter criteria, instead of the using a complicated and limited API. -* New attributes `subject_type` and `subject_identifier` deprecate `subject` - (``__). The `subject` is kept for - backwards compatibility. - * The :program:`waiverdb-cli` utility will now guess a suitable default value for the :option:`--product-version` option in many common cases, in order to make it easier to submit waivers (#111). Automated scripts should prefer to