updaitng changelog and migration guide

NREL · Jun 12, 2023 · 14b9080 · 14b9080
1 parent 490cc24
commit 14b9080
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 17 deletions.
diff --git a/docs/changelog/changelog_2023_06_0.rst b/docs/changelog/changelog_2023_06_0.rst
@@ -0,0 +1,23 @@
+====================
+v2023.06.0 Changelog
+====================
+
+.. changelog::
+    :version: v2023.06.0
+    :released: 2023-06-12
+
+    .. change::
+        :tags: bugfix, feature
+        :pullreq: 374
+        :tickets: 373
+
+        Add read_csv function to utils to handle parsing "None" correctly with pandas > 2.0+. Also add a validator for
+        buildstock_csv that checks if all the entries are available in the options_lookup.tsv.
+
+    .. change::
+        :tags: general, feature
+        :pullreq: 351
+
+        For the Residential HPXML Workflow Generator, add a new ``simple_filepath`` argument
+        for pointing to user-specified CSV file of utility rates. The CSV file can contain utility rates
+        mapped by State, or any other parameter.
diff --git a/docs/changelog/changelog_dev.rst b/docs/changelog/changelog_dev.rst
@@ -14,19 +14,3 @@ Development Changelog
         This is an example change. Please copy and paste it - for valid tags please refer to ``conf.py`` in the docs
         directory. ``pullreq`` should be set to the appropriate pull request number and ``tickets`` to any related
         github issues. These will be automatically linked in the documentation.
-
-    .. change::
-        :tags: bugfix, feature
-        :pullreq: 374
-        :tickets: 373
-
-        Add read_csv function to utils to handle parsing "None" correctly with pandas > 2.0+. Also add a validator for
-        buildstock_csv that checks if all the entries are available in the options_lookup.tsv.
-
-    .. change::
-        :tags: general, feature
-        :pullreq: 351
-
-        For the Residential HPXML Workflow Generator, add a new ``simple_filepath`` argument
-        for pointing to user-specified CSV file of utility rates. The CSV file can contain utility rates
-        mapped by State, or any other parameter.
diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst
@@ -11,14 +11,15 @@ Current Migration Guide
 .. toctree::
    :titlesonly:
 
-   migration_2023_05_0
+   migration_2023_06_0
 
 Change logs
 -----------
 
 .. toctree::
    :titlesonly:
 
+   changelog_2023_06_0
    changelog_2023_05_0
    changelog_2023_01_0
    changelog_2022_12_0
@@ -46,6 +47,7 @@ Older Migration Guides
 .. toctree::
    :titlesonly:
 
+   migration_2023_05_0
    migration_2023_01_0
    migration_2022_12_0
    migration_2022_10_1

diff --git a/docs/changelog/migration_2023_06_0.rst b/docs/changelog/migration_2023_06_0.rst
@@ -0,0 +1,23 @@
+=======================================
+What's new in buildstockbatch 2023.06.0
+=======================================
+
+.. admonition:: About this Document
+
+    This document describes changes between buildstockbatch version 2022.05.0 and
+    buildstockbatch version 2023.06.0
+
+See :doc:`changelog_2023_05_0` for full details of changes since the last version.
+
+General
+=======
+
+This version should be backwards compatible with previous versions of
+buildstockbatch.
+
+Residential HPXML Workflow
+==========================
+
+Updates were made to workflow generator arguments to add a new add a new
+``simple_filepath`` argument, see
+:doc:`../workflow_generators/residential_hpxml` for details.