Skip to content

Commit 451c2a3

Browse files
nllongnllong
authored
Merge pull request #286 from BuildingSync/release/2.3.0-pr1-prep
Release/2.3.0 pr1 prep
2 parents 16eeb82 + 66f7bb1 commit 451c2a3

File tree

4 files changed

+103
-32
lines changed

4 files changed

+103
-32
lines changed

‎BuildingSync.xsd‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<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">
2+
<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">
33
<xs:import namespace="http://www.gbxml.org/schema" schemaLocation="http://www.gbxml.org/schema/6-01/GreenBuildingXML_Ver6.01.xsd"/>
44
<xs:annotation>
5-
<xs:documentation>BuildingSync Schema - Version 2.2.0</xs:documentation>
5+
<xs:documentation>BuildingSync Schema - Version 2.3.0-pr1</xs:documentation>
66
<xs:documentation xmlns="http://www.w3.org/1999/xhtml">
77
<h1>BuildingSync Schema Deprecation Policy</h1>
88
<p>This document details the deprecation policy for the BuildingSync Schema.</p>
@@ -442,6 +442,7 @@
442442
<xs:enumeration value="2.1.0"/>
443443
<xs:enumeration value="2.2.0-pr1"/>
444444
<xs:enumeration value="2.2.0"/>
445+
<xs:enumeration value="2.3.0-pr1"/>
445446
</xs:restriction>
446447
</xs:simpleType>
447448
</xs:attribute>
@@ -470,7 +471,7 @@
470471
<xs:element ref="auc:WeatherStationName" minOccurs="0"/>
471472
<xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
472473
</xs:sequence>
473-
<xs:element ref="auc:WeatherStations" minOccurs="0"></xs:element>
474+
<xs:element ref="auc:WeatherStations" minOccurs="0"/>
474475
</xs:choice>
475476
<xs:element ref="auc:Longitude" minOccurs="0"/>
476477
<xs:element ref="auc:Latitude" minOccurs="0"/>
@@ -519,7 +520,7 @@
519520
<xs:element ref="auc:WeatherStationName" minOccurs="0"/>
520521
<xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
521522
</xs:sequence>
522-
<xs:element ref="auc:WeatherStations" minOccurs="0"></xs:element>
523+
<xs:element ref="auc:WeatherStations" minOccurs="0"/>
523524
</xs:choice>
524525
<xs:element ref="auc:Longitude" minOccurs="0"/>
525526
<xs:element ref="auc:Latitude" minOccurs="0"/>
@@ -18349,18 +18350,18 @@
1834918350
</xs:simpleType>
1835018351
<xs:element name="WeatherStations">
1835118352
<xs:complexType>
18352-
<xs:sequence>
18353-
<xs:element name="WeatherStation" maxOccurs="unbounded">
18354-
<xs:complexType>
18355-
<xs:sequence>
18356-
<xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
18357-
<xs:element ref="auc:WeatherStationName" minOccurs="0"/>
18358-
<xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
18359-
</xs:sequence>
18360-
<xs:attribute name="ID" type="xs:ID" use="required"/>
18361-
</xs:complexType>
18362-
</xs:element>
18363-
</xs:sequence>
18364-
</xs:complexType>
18353+
<xs:sequence>
18354+
<xs:element name="WeatherStation" maxOccurs="unbounded">
18355+
<xs:complexType>
18356+
<xs:sequence>
18357+
<xs:element ref="auc:WeatherDataStationID" minOccurs="0"/>
18358+
<xs:element ref="auc:WeatherStationName" minOccurs="0"/>
18359+
<xs:element ref="auc:WeatherStationCategory" minOccurs="0"/>
18360+
</xs:sequence>
18361+
<xs:attribute name="ID" type="xs:ID" use="required"/>
18362+
</xs:complexType>
18363+
</xs:element>
18364+
</xs:sequence>
18365+
</xs:complexType>
1836518366
</xs:element>
1836618367
</xs:schema>

‎CHANGELOG.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
11
# BuildingSync
22

3+
## Version 2.3.0-PR1
4+
5+
BuildingSync Version 2.3.0-PR1 does not introduce any breaking changes.
6+
7+
Date Range: 09/26/20 - 12/19/20
8+
9+
| Category | Count |
10+
|----------------|-------|
11+
| Controls | 0 |
12+
| General | 2 |
13+
| Measures | 1 |
14+
| Reports | 3 |
15+
| Systems | 3 |
16+
| Validation | 0 |
17+
| Other | 6 |
18+
| **Total** | 15 |
19+
20+
| Change Type | Count |
21+
|----------------|-------|
22+
| Breaking Change | 0 |
23+
| Non-breaking Change | 15 |
24+
25+
New Issues: 16 (#253, #254, #259, #260, #264, #265, #268, #271, #272, #273, #274, #275, #276, #283, #284, #285)
26+
27+
Closed Issues: 4
28+
- Merged [#265]( https://github.com/BuildingSync/schema/issues/265 ), Add modeling of temperature time series
29+
- Merged [#273]( https://github.com/BuildingSync/schema/issues/273 ), TechnologyCategory annotations need to be updated
30+
- Merged [#274]( https://github.com/BuildingSync/schema/issues/274 ), Add 'Install electrical storage' to 'Renewable Energy Systems' TechCat
31+
- Merged [#276]( https://github.com/BuildingSync/schema/issues/276 ), Fix typo in auc:eGRIDRegionCode enumeration
32+
33+
Accepted Pull Requests: 15
34+
- Merged [#255]( https://github.com/BuildingSync/schema/pull/255 ), docs: add notes on git naming conventions
35+
- Merged [#256]( https://github.com/BuildingSync/schema/pull/256 ), Add LinkedSystemIDs to DuctSystem
36+
- Merged [#257]( https://github.com/BuildingSync/schema/pull/257 ), Add estimated as an "engineering calculation"
37+
- Merged [#258]( https://github.com/BuildingSync/schema/pull/258 ), docs(schema): add deprecation warning for Delivery Capacity
38+
- Merged [#261]( https://github.com/BuildingSync/schema/pull/261 ), docs(schema): add deprecation policy
39+
- Merged [#262]( https://github.com/BuildingSync/schema/pull/262 ), docs(examples): update Audit Template example files
40+
- Merged [#263]( https://github.com/BuildingSync/schema/pull/263 ), Add choice for FanInstalledFlowRate. Will deprecate InstalledFanFlowRate.
41+
- Merged [#267]( https://github.com/BuildingSync/schema/pull/267 ), Add weather station element
42+
- Merged [#269]( https://github.com/BuildingSync/schema/pull/269 ), create TimeSeriesReadingQuantity Cost
43+
- Merged [#277]( https://github.com/BuildingSync/schema/pull/277 ), Add derived models to reporting and scenarios
44+
- Merged [#278]( https://github.com/BuildingSync/schema/pull/278 ), Update annotations for data dictionary
45+
- Merged [#279]( https://github.com/BuildingSync/schema/pull/279 ), Add MROE eGridRegion
46+
- Merged [#280]( https://github.com/BuildingSync/schema/pull/280 ), Add new measure for install electrical storage
47+
- Merged [#281]( https://github.com/BuildingSync/schema/pull/281 ), Add GH Actions and Issue Templates
48+
- Merged [#282]( https://github.com/BuildingSync/schema/pull/282 ), `<p>` formatting in XSD
49+
350
## Version 2.2.0
451

552
BuildingSync Version 2.2.0 does not introduce any breaking changes. Version 2.2.0 adds new elements required for a

‎docs/release_instructions.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Follow the steps below when releasing a new version
77
* Update in the first <xs:annotation> element.
88
* Add enumeration to /version with the latest version
99

10-
* Convert XSD to JSON schema. This is still in prototype.
10+
* Convert XSD to JSON schema. This is still in prototype. This functionality will be moved to Oxygen XML soon.
1111
* Use XMLSpy to Generate JSON Schema (Convert->Convert XML Schema to/from JSON Schema...)
1212
* Use the default options
1313

@@ -29,15 +29,13 @@ Follow the steps below when releasing a new version
2929
* After merging the Pull Request, draft a release in GitHub.
3030
* *Upload the XSD and JSON file as part of the release.*
3131

32-
* Use XMLSpy to generate documentation (files will be saved to this (repo)[https://github.com/BuildingSync/website]).
33-
34-
* Schema Design -> Generate Documentation
35-
* Set to HTML
36-
* Check all the includes and details
37-
* Make sure to output to a single file (uncheck "Split output in multiple files")
38-
* Embed CSS into HTML
39-
* Export as `index.html` in the website's `schema/vX.Y/documentation` folder.
40-
32+
* Use Oxygen XML to generate the documentation. The documentation will actually be saved in [this repo](https://github.com/BuildingSync/website]).
33+
* Tools -> Generate Documentation -> XML Schema Documentation
34+
* Choose *Format HTML*
35+
* Check *split output into multiple* and *Split by location*
36+
* Set directory and name to be the website's folder `schema/vX.Y.Z/documentation/index.html`. The name needs to be `index.html`.
37+
* Select *Generate*
38+
4139
* Edit the BuildingSync Website GitHub repo on a new branch (https://github.com/BuildingSync/website):
4240

4341
* 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:

‎src/change_log.rb‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,30 @@ def get_title(issue)
7272

7373
def print_issue(issue)
7474
is_feature = false
75-
issue.labels.each {|label| is_feature = true if label.name == 'Feature Request'}
75+
issue.labels.each {|label| is_feature = true if label.name == 'feature'}
76+
is_enhancement = false
77+
issue.labels.each {|label| is_enhancement = true if label.name == 'enhancement'}
78+
is_bug = false
79+
issue.labels.each {|label| is_bug = true if label.name == 'bug'}
80+
ignore = false
81+
issue.labels.each {|label| ignore = true if label.name == 'ignore'}
82+
83+
quick_check = [is_feature, is_enhancement, is_bug]
84+
if !quick_check.none? and !quick_check.one?
85+
raise "Cannot only have one of [feature, enhancement, bug]. Seen on #{get_html_url(issue)}"
86+
end
7687

7788
if is_feature
78-
"- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
89+
text = "- New Feature [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
90+
elsif is_enhancement
91+
text = "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
92+
elsif is_bug
93+
text = "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
7994
else
80-
"- Merged [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
95+
text = "- Merged [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
8196
end
97+
98+
[text, ignore]
8299
end
83100

84101
# Process Open Issues
@@ -110,6 +127,7 @@ def print_issue(issue)
110127
# container for storing category of changes
111128
categories = {
112129
"Controls" => 0,
130+
"Documentation" => 0,
113131
"General" => 0,
114132
"Measures" => 0,
115133
"Reports" => 0,
@@ -186,10 +204,17 @@ def print_issue(issue)
186204
puts "\nNew Issues: #{new_issues.length} (" + new_issues.map {|issue| get_issue_num(issue)}.join(', ') + ')'
187205

188206
puts "\nClosed Issues: #{closed_issues.length}"
189-
closed_issues.each {|issue| puts print_issue(issue)}
207+
208+
closed_issues.each do |issue|
209+
issue_text, ignore = print_issue(issue)
210+
puts issue_text if not ignore
211+
end
190212

191213
puts "\nAccepted Pull Requests: #{accepted_pull_requests.length}"
192-
accepted_pull_requests.each {|issue| puts print_issue(issue)}
214+
accepted_pull_requests.each do |issue|
215+
issue_text, ignore = print_issue(issue)
216+
puts issue_text if not ignore
217+
end
193218

194219
puts "\nAll Open Issues: #{total_open_issues.length} (" + total_open_issues.map {|issue| get_issue_num(issue)}.join(', ') + ')'
195220

0 commit comments

Comments
 (0)