Merge pull request #336 from ZLLentz/rel_v2.4.0

REL: v2.4.0
pcdshub · Sep 27, 2023 · 9819438 · 9819438
2 parents bee7417 + a7d5f86
commit 9819438
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 210 deletions.
diff --git 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 <https://github.com/mongodb/mongo-python-driver/tree/master#installation>`)
+
+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
diff --git a/docs/source/upcoming_release_notes/304-remove_temporary_file.rst b/docs/source/upcoming_release_notes/304-remove_temporary_file.rst
diff --git a/docs/source/upcoming_release_notes/318-mnt_mongo_backend.rst b/docs/source/upcoming_release_notes/318-mnt_mongo_backend.rst
diff --git a/docs/source/upcoming_release_notes/320-bug_update_json.rst b/docs/source/upcoming_release_notes/320-bug_update_json.rst
diff --git a/docs/source/upcoming_release_notes/322-happi-audit-split.rst b/docs/source/upcoming_release_notes/322-happi-audit-split.rst
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
diff --git a/docs/source/upcoming_release_notes/331-pcds-libraries-requirement.rst b/docs/source/upcoming_release_notes/331-pcds-libraries-requirement.rst
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
diff --git a/docs/source/upcoming_release_notes/335-bug_xfer_default.rst b/docs/source/upcoming_release_notes/335-bug_xfer_default.rst
diff --git 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
@@ -1,8 +1,8 @@
 IssueNumber Title
 #################
 
-API Changes
------------
+API Breaks
+----------
 - N/A
 
 Features