Merge pull request #1166 from nexusformat/1165-changes-for-2022.06-re…

…lease

Document the changes for 2022.06 release.

@PeterC-DLS Thanks for the review!  Once this is merged, you can tag the 2022.06 release.

CHANGES.rst

@@ -1,55 +1,199 @@
 ..
   This file describes user-visible changes between the versions.
 
-  This human-composed file has been useful in other projects
-  useful to point out specific issues and pull requests that
-  contribute to a release. It can be composed as issues/PRs
-  are resolved and then cited from the release page documentation.
-
   Highlights from the Change History, especially new releases,
-  should be added to manual/source/history.rst.
+  should be added to manual/history.rst.
+
+  subsections could include these headings (in this order), omit if no content
+
+    Notice
+    Breaking Changes
+    New Features and/or Enhancements
+    Fixes
+    Maintenance
+    Deprecations
+    Contributors
 
 Change History
 ##############
 
-:v2022.06:  expected *2022-06*
+Highlights of each release are described below.  For more details, see our wiki
+(https://github.com/nexusformat/definitions/wiki/Release-Notes)
+which provides links to the Release Notes (itemized list of changes) for any release.
+
+
+v2022.06
+++++++++
+
+released *2022-07-05*
+
+This release is the result of
+a virtual NIAC meeting in 2022-03,
+NeXus Code Camps in 2021-03 and 2022-06,
+and substantial work by both the NeXus Community and NIAC members.
+
+Summary statistics from the GitHub definitions repository show
+this activity since the (previous) v2020.10 release:
+
+=============   ========
+activity        quantity
+=============   ========
+Pull Requests   134
+Issues          101
+Commits         250
+=============   ========
+
+See the wiki for more details:
+https://github.com/nexusformat/definitions/wiki/releasenotes__v2022.06
+
+.. nothing to report here
+  Notice
+  ------
+
+Breaking Changes
+----------------
+
+* Included PDF files moved ``/pdf/`` to ``/_static/``.
+
+* Minimum Python requirement (for testing and building documentation):  3.7
+
+* ``NXsample``: Removed group named ``temperature``.
+
+* ``NXsnsevent`` & ``NXsnshisto``: category changed to ``application`` (was ``base``)
+
+* Publishing workflow completely rebuilt in Python, now in ``/dev_tools/``
+  directory (was in ``/utils/``).  All Python code adheres to automated
+  code style checking (``black`` and ``flake8``).
+
+New Features
+------------
+
+* contributed definitions:
+
+  * atom probe microscopy
+  * electron microscopy
+  * ellipsometry
+  * multidimensional photoemission spectroscopy
+  * ``NXregion``
+  * X-ray photon correlation spectroscopy
+
+* Full vocabulary (names of all groups, fields, attributes, and links) now built
+  and published in the manual.
+
+* ``NX_COMPLEX`` data type to describe complex numbers.
+
+* ``NX_COUNT`` unit type to describe counting events.
+
+Enhancements
+------------
+
+* All classes provide a list of reST & HTML anchors to every defined item
+  (groups, fields, attributes, & links).
 
-    .. TODO: document more changes
+Maintenance
+-----------
 
-    * `#955 <https://github.com/nexusformat/definitions/issues/955>`_
-       Documentation built and published from GitHub Actions workflow
+* Add
 
-    * `#952 <https://github.com/nexusformat/definitions/issues/952>`_
-       - drop support for Python <3.7 when building documentation & testing NXDL files
-       - included PDF file subdirectory changed from `pdf/` to `_static/`
+  * ``depends_on`` (field) and ``NXtransformations`` (group)
+    to more base classes.
+  * ``NXdetector``: ``image_key``
+  * ``NXdetector``, ``NXmx``: ``countrate_correction_lookup_table``
 
-    * `#884 <https://github.com/nexusformat/definitions/issues/884>`_
-       switch repository default branch from master to main
+* Change GitHub default branch to ``main`` (was ``master``).
 
-    * `#878 <https://github.com/nexusformat/definitions/issues/878>`_
-       Minimum Python requirement now:  3.6
+* Clarify:
 
-       * All classes provide a list of reST & HTML anchors to
-         every defined item (groups, fields, attributes, & links).
+  * naming rule of NXDL XML files
+  * symbol table in NXDL files
+  * ``NXdetector``: ``dimensions``
+  * how ``default`` attribute is used to find the plottable data
+  * ``NXBeam``: various symbols and polarization fields
 
-:v2020.10:  released *2020-12-08*
+* Documentation built and published from GitHub Actions workflow
+
+* Switch repository default branch from master to main.
+
+* Units of flux corrected.
+
+* Various documentation revised:
+
+  * Description of links
+
+Deprecations
+------------
+
+* ``incr`` attribute of ``dimensionType``
+* ``NXspecdata`` contributed definition withdrawn and removed.
+
+Contributors
+------------
+
+In addition to the NIAC members, these people have contributed to this release:
+
+* Advanced Light Source
+
+  * Dylan McReynolds
+  * Ron Pandolfi
+  * Juliane Reinhardt
+  * Padraic Shafer
+
+* Advanced Photon Source
+
+  * Daniel Ching
+  * Miaoqi Chu
+  * Suresh Narayanan
+  * Qingteng Zhang
+
+* Dectris
+
+  * Sophie Hotz
+  * Kal Conley
+
+* Diamond Light Source
+
+  * Tim Snow
+
+* FAIRmat
+
+  * Carola Emminger
+  * Florian Dobener
+  * Markus Kühbach
+  * Andrea Albino
+
+* National Synchrotron Light Source II
+
+  * Abby Giles
+  * Andi Barbour
+
+v2020.10
+++++++++
+
+released *2020-12-08*
 
     * see Release Notes wiki: https://github.com/nexusformat/definitions/wiki/releasenotes_v2020.10
 
-:v2020.1:  released *2020-01-31*
+v2020.1
++++++++
+
+released *2020-01-31*
 
     * see Release Notes wiki: https://github.com/nexusformat/definitions/wiki/releasenotes_v2020.1
     * The manual is now published through GitHub Pages: https://manual.nexusformat.org
     * We have a DOI (with zenodo https://zenodo.org/record/3629571) that updates with each release of the definitions repository.  The DOI link is noted on our GitHub home page.
 
-:v2018.5:  released *2018-05-15*
+v2018.5
+++++++++
+
+released *2018-05-15*
 
     * `v2018.5 <https://github.com/nexusformat/definitions/releases/tag/v2018.5>`_
        see release notes: https://github.com/nexusformat/definitions/wiki/releasenotes__v2018.5
     * `#597 <https://github.com/nexusformat/definitions/issues/597>`_
        changed versioning scheme and procedures
 
-:releases before v2018.5:
+Releases before v2018.5
++++++++++++++++++++++++
 
     * 3.3
     * 3.2

manual/source/history.rst

@@ -11,6 +11,18 @@ Two things to note about the development and history of NeXus:
 
 - The NIAC has already discussed many matters related to the format.
 
+2022-07:
+    * `release v2022.06 <https://github.com/nexusformat/definitions/wiki/releasenotes__v2022.06>`
+      of NeXus Definitions
+
+2020-10:
+    * `release v2020.10 <https://github.com/nexusformat/definitions/wiki/releasenotes__v2020.10>`
+      of NeXus Definitions
+
+2020-01:
+    * `release v2020.1 <https://github.com/nexusformat/definitions/wiki/releasenotes__v2020.1>`
+      of NeXus Definitions
+
 2018-05:
     * `release v2018.5 <https://github.com/nexusformat/definitions/wiki/releasenotes__v2018.5>`
       of NeXus Definitions