diff --git a/docs/source/releases.rst b/docs/source/releases.rst index f8e8f277..9743db16 100644 --- a/docs/source/releases.rst +++ b/docs/source/releases.rst @@ -2,6 +2,45 @@ Release History ############### +v2.4.0 (2023-09-27) +=================== + +Features +-------- +- Added ``happi.audit.audit()`` which can be used to programmatically audit + happi items. + +Bugfixes +-------- +- Fixes bug where `happi transfer` was not filling default values properly +- Fixes conftest.trim_split_output, which was effectively a no-op. Touches up affected tests +- Issue 302: Add functionality to happi 'repair' that ensures that the name and id fields of a device are the same. +- Removes an extra pcdsutils import from test_cli.py that is not properly caught by error handling + +Maintenance +----------- +- Adds error handling for the temporary file created when initializing a json backend object. +- Changes format of temporary file name generation to contain only a unique hash. +- Tests modified to no longer assert stdout matches expected strings. Rather the effect of the + command being tested is verified independently. The `assert_match_expected` helper is still + used, but will now print mismatches instead of asserting them. +- Allows `happi update` to handle json-backend-type payloads +- Adds pcdsutils and pcdsdevices to environment requirements in conda recipe and dev requirements +- Removes pcdsutils and pcdsdevices from extra testing requirements in github workflow +- The ``happi audit`` CLI entrypoint has been modified to use + ``happi.audit.audit()``. +- Updates mongo backend to handle authSource, require connection information (host, user, etc) +- Documents bson dependency. Bson is vendored by pymongo, which instructs + users to not install bson from pypi (`pymongo readme `) + +Contributors +------------ +- klauer +- laura-king +- tangkong + + + v2.3.0 (2023-06-30) =================== diff --git a/docs/source/upcoming_release_notes/302-repair_match_name_to_id.rst b/docs/source/upcoming_release_notes/302-repair_match_name_to_id.rst deleted file mode 100644 index 436190c1..00000000 --- a/docs/source/upcoming_release_notes/302-repair_match_name_to_id.rst +++ /dev/null @@ -1,22 +0,0 @@ -302 repair_match_name_to_id -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- Issue 302: Add functionality to happi 'repair' that ensures that the name and id fields of a device are the same. - -Maintenance ------------ -- N/A - -Contributors ------------- -- laura-king diff --git a/docs/source/upcoming_release_notes/304-remove_temporary_file.rst b/docs/source/upcoming_release_notes/304-remove_temporary_file.rst deleted file mode 100644 index 50cffb82..00000000 --- a/docs/source/upcoming_release_notes/304-remove_temporary_file.rst +++ /dev/null @@ -1,23 +0,0 @@ -304 remove_temporary_file -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Adds error handling for the temporary file created when initializing a json backend object. -- Changes format of temporary file name generation to contain only a unique hash. - -Contributors ------------- -- laura-king diff --git a/docs/source/upcoming_release_notes/318-mnt_mongo_backend.rst b/docs/source/upcoming_release_notes/318-mnt_mongo_backend.rst deleted file mode 100644 index 38d53ec5..00000000 --- a/docs/source/upcoming_release_notes/318-mnt_mongo_backend.rst +++ /dev/null @@ -1,22 +0,0 @@ -318 mnt_mongo_backend -##################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Update mongo backend to handle authSource, require connection information (host, user, etc) - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/320-bug_update_json.rst b/docs/source/upcoming_release_notes/320-bug_update_json.rst deleted file mode 100644 index 57dfbeb3..00000000 --- a/docs/source/upcoming_release_notes/320-bug_update_json.rst +++ /dev/null @@ -1,22 +0,0 @@ -320 bug_update_json -################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Allow `happi update` to handle json-backend-type payloads - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/322-happi-audit-split.rst b/docs/source/upcoming_release_notes/322-happi-audit-split.rst deleted file mode 100644 index f5da36c1..00000000 --- a/docs/source/upcoming_release_notes/322-happi-audit-split.rst +++ /dev/null @@ -1,24 +0,0 @@ -322 happi-audit-split -##################### - -API Changes ------------ -- N/A - -Features --------- -- Added ``happi.audit.audit()`` which can be used to programmatically audit - happi items. - -Bugfixes --------- -- N/A - -Maintenance ------------ -- The ``happi audit`` CLI entrypoint has been modified to use - ``happi.audit.audit()``. - -Contributors ------------- -- klauer diff --git a/docs/source/upcoming_release_notes/329-remove-extra-pcdsutils-import.rst b/docs/source/upcoming_release_notes/329-remove-extra-pcdsutils-import.rst deleted file mode 100644 index 1df97750..00000000 --- a/docs/source/upcoming_release_notes/329-remove-extra-pcdsutils-import.rst +++ /dev/null @@ -1,22 +0,0 @@ -329 remove-extra-pcdsutils-import -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- Remove an extra pcdsutils import from test_cli.py that is not properly caught by error handling - -Maintenance ------------ -- N/A - -Contributors ------------- -- laura-king diff --git a/docs/source/upcoming_release_notes/331-pcds-libraries-requirement.rst b/docs/source/upcoming_release_notes/331-pcds-libraries-requirement.rst deleted file mode 100644 index e32a49c6..00000000 --- a/docs/source/upcoming_release_notes/331-pcds-libraries-requirement.rst +++ /dev/null @@ -1,23 +0,0 @@ -331 pcds-libraries-requirement -################# - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Add pcdsutils and pcdsdevices to environment requirements in conda recipe and dev requirements -- Remove pcdsutils and pcdsdevices from extra testing requirements in github workflow - -Contributors ------------- -- laura-king diff --git a/docs/source/upcoming_release_notes/333-doc_bson_not_req.rst b/docs/source/upcoming_release_notes/333-doc_bson_not_req.rst deleted file mode 100644 index ee23f8ab..00000000 --- a/docs/source/upcoming_release_notes/333-doc_bson_not_req.rst +++ /dev/null @@ -1,23 +0,0 @@ -333 doc_bson_not_req -#################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- N/A - -Maintenance ------------ -- Documents bson dependency. Bson is vendored by pymongo, which instructs - users to not install bson from pypi (`pymongo readme `) - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/335-bug_xfer_default.rst b/docs/source/upcoming_release_notes/335-bug_xfer_default.rst deleted file mode 100644 index 7c641113..00000000 --- a/docs/source/upcoming_release_notes/335-bug_xfer_default.rst +++ /dev/null @@ -1,25 +0,0 @@ -335 bug_xfer_default -#################### - -API Changes ------------ -- N/A - -Features --------- -- N/A - -Bugfixes --------- -- Fixes bug where `happi transfer` was not filling default values properly -- Fixes conftest.trim_split_output, which was effectively a no-op. Touches up affected tests - -Maintenance ------------ -- Tests modified to no longer assert stdout matches expected strings. Rather the effect of the - command being tested is verified independently. The `assert_match_expected` helper is still - used, but will now print mismatches instead of asserting them. - -Contributors ------------- -- tangkong diff --git a/docs/source/upcoming_release_notes/template-full.rst b/docs/source/upcoming_release_notes/template-full.rst index 9f86b87e..31657f76 100644 --- a/docs/source/upcoming_release_notes/template-full.rst +++ b/docs/source/upcoming_release_notes/template-full.rst @@ -7,8 +7,8 @@ Your filename should be issuenumber-title.rst, substituting appropriately. Make sure to fill out any section that represents changes you have made, or replace the default bullet point with N/A. -API Changes ------------ +API Breaks +---------- - List backwards-incompatible changes here. Changes to PVs don't count as API changes for this library, but changing method and component names or changing default behavior does. diff --git a/docs/source/upcoming_release_notes/template-short.rst b/docs/source/upcoming_release_notes/template-short.rst index 5e544ecf..8349cd8a 100644 --- a/docs/source/upcoming_release_notes/template-short.rst +++ b/docs/source/upcoming_release_notes/template-short.rst @@ -1,8 +1,8 @@ IssueNumber Title ################# -API Changes ------------ +API Breaks +---------- - N/A Features