Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions BuildingSync.xsd
Original file line number Diff line number Diff line change
@@ -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.5.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.6.0">
<xs:import namespace="http://www.gbxml.org/schema" schemaLocation="https://github.com/BuildingSync/gbXML_Schemas/releases/download/v6.01/GreenBuildingXML_Ver6.01.xsd"/>
<xs:annotation>
<xs:documentation>BuildingSync Schema - Version 2.5.0</xs:documentation>
<xs:documentation>BuildingSync Schema - Version 2.6.0</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>
Expand Down Expand Up @@ -451,6 +451,8 @@
<xs:enumeration value="2.4"/>
<xs:enumeration value="2.5.0"/>
<xs:enumeration value="2.5"/>
<xs:enumeration value="2.6.0"/>
<xs:enumeration value="2.6"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
Expand Down
44 changes: 44 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
# BuildingSync

## Version 2.6.0

BuildingSync Version 2.6.0 adds new elements for Life-Cycle Savings and two new measures for fenestration systems.

Date Range: 09/21/23 - 09/24/24

| Category | Count |
|----------------|-------|
| Schema: Controls | 0 |
| Schema: Documentation | 1 |
| Schema: General | 1 |
| Schema: Measures | 2 |
| Schema: Reports | 1 |
| Schema: Systems | 0 |
| Schema: Validation | 0 |
| Other | -1 |
| **Total** | 4 |

### Breaking Changes

*No breaking changes*

### Non-breaking Changes
- [#495](https://github.com/BuildingSync/schema/pull/495), Add Life Cycle Savings elements (`Measures`, `Reports`)
- [#494](https://github.com/BuildingSync/schema/pull/494), Add AuditCycleStartDate and AuditCycleEndDate (`General`)
- [#492](https://github.com/BuildingSync/schema/pull/492), Add fenestration system measures (`Measures`)
- [#487](https://github.com/BuildingSync/schema/pull/487), Update examples to 2.5 (`Documentation`)

### Non-schema Changes

*No non-schema changes*

### Issues

New Issues: 3 (#490, #491, #493)

Closed Issues: 4
- [#465]( https://github.com/BuildingSync/schema/issues/465 ), [9/29/23] Updated release of BuildingSync 2.5 Milestone
- [#490]( https://github.com/BuildingSync/schema/issues/490 ), Requested addition of fenestration system (window/shading retrofit) measures (`Measures`, `Non-breaking Change`, `feature`)
- [#491]( https://github.com/BuildingSync/schema/issues/491 ), Requested new elements for life-cycle analysis or financial/project management for CTS/eProjectBuilder (initial) (`Reports`, `General`, `Non-breaking Change`, `feature`)
- [#493]( https://github.com/BuildingSync/schema/issues/493 ), Requested addition of AuditCycleStartDate and AuditCycleEndDate (`General`, `Non-breaking Change`, `feature`)

All Open Issues: 19 (#151, #154, #167, #170, #183, #195, #198, #218, #260, #285, #287, #297, #320, #356, #370, #391, #428, #450, #474)

## Version 2.5.0

BuildingSync Version 2.5.0 adds new elements for Water Conservation Measures (WCMs) and emission-related fields (Greenhouse Gas Emission). Version 2.5.0 adds examples of interactive Jupyter Notebooks to illustrate the process of creating BuildingSync XML reports from building data, where the synthetic data was generated based on DOE prototype buildings (small office and primary school).
Expand Down
13 changes: 8 additions & 5 deletions docs/release_instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ Follow the steps below when releasing a new version
* Update version in the "schema title", at `/xs:schema/xs:annotation/xs:documentation[1]`.
* If creating an official release (i.e., you are NOT creating a pre-release), add the version as an enumeration to the `auc:BuildingSync` `version` attribute with the latest version. Though we historically added some pre-releases to `@version`, they should no longer be included.

* Update the CHANGELOG.md to include the latest changes, and the most recent version.

* Run the change_log.rb script (e.g., ruby src/change_log.rb -t abcdefghijklmnopqrstuvwxyz -s 2019-12-21). The date range must span from the last official release (ie don't start at a pre-release) until the current date.
* Update the CHANGELOG.md to include the latest changes, and the most recent version:
* Obtain [Github API token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) for the next step.
* Run the change_log.rb script (e.g., ruby src/change_log.rb -t TOKEN_string -s 2019-12-21). The date range must span from the last official release (ie don't start at a pre-release) until the current date.
* Copy the results of this into the CHANGELOG. Remove items that are not useful to an end user such as version bumps, formatting, etc.
* Create a Pull Request (prep release) into `develop`:
* Mark the PR with an `ignore` label to prevent the PR from being added to future change logs.
* Merge the PR.

* Create a Pull Request into `main`
* Create a Pull Request (release) into `main`:
* Mark the PR with an `ignore` label to prevent the PR from being added to future change logs.
* Merge the PR
* Merge the PR.

### Tag and release

Expand Down