Merge pull request #286 from BuildingSync/release/2.3.0-pr1-prep

Release/2.3.0 pr1 prep
BuildingSync · Dec 18, 2020 · 451c2a3 · 451c2a3
2 parents 16eeb82 + 66f7bb1
commit 451c2a3
Show file tree

Hide file tree

Showing 4 changed files with 103 additions and 32 deletions.
diff --git a/BuildingSync.xsd b/BuildingSync.xsd
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:gbxml="http://www.gbxml.org/schema" targetNamespace="http://buildingsync.net/schemas/bedes-auc/2019" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.2.0">
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:gbxml="http://www.gbxml.org/schema" targetNamespace="http://buildingsync.net/schemas/bedes-auc/2019" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.3.0-pr1">
   <xs:import namespace="http://www.gbxml.org/schema" schemaLocation="http://www.gbxml.org/schema/6-01/GreenBuildingXML_Ver6.01.xsd"/>
   <xs:annotation>
-    <xs:documentation>BuildingSync Schema - Version 2.2.0</xs:documentation>
+    <xs:documentation>BuildingSync Schema - Version 2.3.0-pr1</xs:documentation>
     <xs:documentation xmlns="http://www.w3.org/1999/xhtml">
       <h1>BuildingSync Schema Deprecation Policy</h1>
       <p>This document details the deprecation policy for the BuildingSync Schema.</p>
@@ -442,6 +442,7 @@
             <xs:enumeration value="2.1.0"/>
             <xs:enumeration value="2.2.0-pr1"/>
             <xs:enumeration value="2.2.0"/>
+            <xs:enumeration value="2.3.0-pr1"/>
           </xs:restriction>
         </xs:simpleType>
       </xs:attribute>
@@ -470,7 +471,7 @@
           <xs:element ref="auc:WeatherStationName" minOccurs="0"/>
           <xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
         </xs:sequence>
-        <xs:element ref="auc:WeatherStations" minOccurs="0"></xs:element>
+        <xs:element ref="auc:WeatherStations" minOccurs="0"/>
       </xs:choice>
       <xs:element ref="auc:Longitude" minOccurs="0"/>
       <xs:element ref="auc:Latitude" minOccurs="0"/>
@@ -519,7 +520,7 @@
           <xs:element ref="auc:WeatherStationName" minOccurs="0"/>
           <xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
         </xs:sequence>
-        <xs:element ref="auc:WeatherStations" minOccurs="0"></xs:element>
+        <xs:element ref="auc:WeatherStations" minOccurs="0"/>
       </xs:choice>
       <xs:element ref="auc:Longitude" minOccurs="0"/>
       <xs:element ref="auc:Latitude" minOccurs="0"/>
@@ -18349,18 +18350,18 @@
   </xs:simpleType>
   <xs:element name="WeatherStations">
     <xs:complexType>
-        <xs:sequence>
-            <xs:element name="WeatherStation" maxOccurs="unbounded">
-                <xs:complexType>
-                    <xs:sequence>
-                        <xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
-                        <xs:element ref="auc:WeatherStationName" minOccurs="0"/>
-                        <xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
-                    </xs:sequence>
-                    <xs:attribute name="ID" type="xs:ID" use="required"/>
-                  </xs:complexType>
-              </xs:element>
-          </xs:sequence>
-      </xs:complexType>
+      <xs:sequence>
+        <xs:element name="WeatherStation" maxOccurs="unbounded">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
+              <xs:element ref="auc:WeatherStationName" minOccurs="0"/>
+              <xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
+            </xs:sequence>
+            <xs:attribute name="ID" type="xs:ID" use="required"/>
+          </xs:complexType>
+        </xs:element>
+      </xs:sequence>
+    </xs:complexType>
   </xs:element>
 </xs:schema>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,52 @@
 # BuildingSync
 
+## Version 2.3.0-PR1
+
+BuildingSync Version 2.3.0-PR1 does not introduce any breaking changes. 
+
+Date Range: 09/26/20 - 12/19/20
+
+| Category       | Count |
+|----------------|-------|
+| Controls         | 0  |
+| General         | 2  |
+| Measures         | 1  |
+| Reports         | 3  |
+| Systems         | 3  |
+| Validation         | 0  |
+| Other         | 6  |
+| **Total**      | 15 |
+
+| Change Type    | Count |
+|----------------|-------|
+| Breaking Change         | 0  |
+| Non-breaking Change         | 15  |
+
+New Issues: 16 (#253, #254, #259, #260, #264, #265, #268, #271, #272, #273, #274, #275, #276, #283, #284, #285)
+
+Closed Issues: 4
+- Merged [#265]( https://github.com/BuildingSync/schema/issues/265 ), Add modeling of temperature time series
+- Merged [#273]( https://github.com/BuildingSync/schema/issues/273 ), TechnologyCategory annotations need to be updated
+- Merged [#274]( https://github.com/BuildingSync/schema/issues/274 ), Add 'Install electrical storage' to 'Renewable Energy Systems' TechCat
+- Merged [#276]( https://github.com/BuildingSync/schema/issues/276 ), Fix typo in auc:eGRIDRegionCode enumeration
+
+Accepted Pull Requests: 15
+- Merged [#255]( https://github.com/BuildingSync/schema/pull/255 ), docs: add notes on git naming conventions
+- Merged [#256]( https://github.com/BuildingSync/schema/pull/256 ), Add LinkedSystemIDs to DuctSystem
+- Merged [#257]( https://github.com/BuildingSync/schema/pull/257 ), Add estimated as an "engineering calculation"
+- Merged [#258]( https://github.com/BuildingSync/schema/pull/258 ), docs(schema): add deprecation warning for Delivery Capacity
+- Merged [#261]( https://github.com/BuildingSync/schema/pull/261 ), docs(schema): add deprecation policy
+- Merged [#262]( https://github.com/BuildingSync/schema/pull/262 ), docs(examples): update Audit Template example files
+- Merged [#263]( https://github.com/BuildingSync/schema/pull/263 ), Add choice for FanInstalledFlowRate. Will deprecate InstalledFanFlowRate.
+- Merged [#267]( https://github.com/BuildingSync/schema/pull/267 ), Add weather station element
+- Merged [#269]( https://github.com/BuildingSync/schema/pull/269 ), create TimeSeriesReadingQuantity Cost
+- Merged [#277]( https://github.com/BuildingSync/schema/pull/277 ), Add derived models to reporting and scenarios
+- Merged [#278]( https://github.com/BuildingSync/schema/pull/278 ), Update annotations for data dictionary
+- Merged [#279]( https://github.com/BuildingSync/schema/pull/279 ), Add MROE eGridRegion
+- Merged [#280]( https://github.com/BuildingSync/schema/pull/280 ), Add new measure for install electrical storage
+- Merged [#281]( https://github.com/BuildingSync/schema/pull/281 ), Add GH Actions and Issue Templates
+- Merged [#282]( https://github.com/BuildingSync/schema/pull/282 ), `<p>` formatting in XSD
+
 ## Version 2.2.0
 
 BuildingSync Version 2.2.0 does not introduce any breaking changes. Version 2.2.0 adds new elements required for a 

diff --git a/docs/release_instructions.md b/docs/release_instructions.md
@@ -7,7 +7,7 @@ Follow the steps below when releasing a new version
     * Update in the first <xs:annotation> element.
     * Add enumeration to /version with the latest version 
 
-* Convert XSD to JSON schema. This is still in prototype. 
+* Convert XSD to JSON schema. This is still in prototype. This functionality will be moved to Oxygen XML soon.
     * Use XMLSpy to Generate JSON Schema (Convert->Convert XML Schema to/from JSON Schema...)
     * Use the default options
 
@@ -29,15 +29,13 @@ Follow the steps below when releasing a new version
     * After merging the Pull Request, draft a release in GitHub. 
     * *Upload the XSD and JSON file as part of the release.*
 
-* Use XMLSpy to generate documentation (files will be saved to this (repo)[https://github.com/BuildingSync/website]).
-
-    * Schema Design -> Generate Documentation
-    * Set to HTML
-    * Check all the includes and details
-    * Make sure to output to a single file (uncheck "Split output in multiple files")
-    * Embed CSS into HTML
-    * Export as `index.html` in the website's `schema/vX.Y/documentation` folder.
-
+* Use Oxygen XML to generate the documentation. The documentation will actually be saved in [this repo](https://github.com/BuildingSync/website]).
+    * Tools -> Generate Documentation -> XML Schema Documentation
+    * Choose *Format HTML*
+    * Check *split output into multiple* and *Split by location*    
+    * Set directory and name to be the website's folder `schema/vX.Y.Z/documentation/index.html`. The name needs to be `index.html`.
+    * Select *Generate*
+
 * Edit the BuildingSync Website GitHub repo on a new branch (https://github.com/BuildingSync/website):
 
 	* Run the schema's rake task for generating the data dictionary (`bundle exec rake generate_data_dictionary`). This will create the list of enumerations in both JSON and XSLX format. In the BuildingSync/website repository:

diff --git a/src/change_log.rb b/src/change_log.rb
@@ -72,13 +72,30 @@ def get_title(issue)
 
 def print_issue(issue)
   is_feature = false
-  issue.labels.each {|label| is_feature = true if label.name == 'Feature Request'}
+  issue.labels.each {|label| is_feature = true if label.name == 'feature'}
+  is_enhancement = false
+  issue.labels.each {|label| is_enhancement = true if label.name == 'enhancement'}
+  is_bug = false
+  issue.labels.each {|label| is_bug = true if label.name == 'bug'}
+  ignore = false
+  issue.labels.each {|label| ignore = true if label.name == 'ignore'}
+
+  quick_check = [is_feature, is_enhancement, is_bug]
+  if !quick_check.none? and !quick_check.one?
+    raise "Cannot only have one of [feature, enhancement, bug]. Seen on #{get_html_url(issue)}"
+  end
 
   if is_feature
-    "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+    text = "- New Feature [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  elsif is_enhancement
+    text = "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  elsif is_bug
+    text = "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
   else
-    "- Merged [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+    text = "- Merged [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
   end
+
+  [text, ignore]
 end
 
 # Process Open Issues
@@ -110,6 +127,7 @@ def print_issue(issue)
 # container for storing category of changes
 categories = {
   "Controls" => 0,
+  "Documentation" => 0,
   "General" => 0,
   "Measures" => 0,
   "Reports" => 0,
@@ -186,10 +204,17 @@ def print_issue(issue)
 puts "\nNew Issues: #{new_issues.length} (" + new_issues.map {|issue| get_issue_num(issue)}.join(', ') + ')'
 
 puts "\nClosed Issues: #{closed_issues.length}"
-closed_issues.each {|issue| puts print_issue(issue)}
+
+closed_issues.each do |issue|
+  issue_text, ignore = print_issue(issue)
+  puts issue_text if not ignore
+end
 
 puts "\nAccepted Pull Requests: #{accepted_pull_requests.length}"
-accepted_pull_requests.each {|issue| puts print_issue(issue)}
+accepted_pull_requests.each do |issue|
+  issue_text, ignore = print_issue(issue)
+  puts issue_text if not ignore
+end
 
 puts "\nAll Open Issues: #{total_open_issues.length} (" + total_open_issues.map {|issue| get_issue_num(issue)}.join(', ') + ')'