Skip to content

Commit 5c118b1

Browse files
committed
update versions in examples and docs
1 parent 590afad commit 5c118b1

30 files changed

+39
-34
lines changed

docs/notebooks/bsync_examples/Primary-School-Levels1-2.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This notebook uses resources from:
1414

1515
- the [DOE Commercial Prorotype buildings](https://www.energycodes.gov/prototype-building-models) repository
1616
- ASHRAE [Standard 211](https://www.ashrae.org/technical-resources/bookstore/standards-180-and-211) for formal guidelines on energy audits
17-
- the [BuildingSync schema documentation](https://buildingsync.net/dictionary/2.5.0/)
17+
- the [BuildingSync schema documentation](https://buildingsync.net/dictionary/2.6.0/)
1818
- the [notebook included in the bsync examples folder](./Small-Office-Level-1.md) for a comprehensive explanation on basic BuildingSync and bsyncpy concepts
1919

2020
## 3. Overview
@@ -27,7 +27,7 @@ This notebook is broken down into the following sections:
2727

2828
3) Adding the information required for a Level 2 energy audit
2929

30-
4) Generating a BuildingSync file and verifying it against version 2.5.0 of the BuildingSync schema
30+
4) Generating a BuildingSync file and verifying it against version 2.6.0 of the BuildingSync schema
3131

3232

3333
But first, let us import the required libraries and set up some useful functions:
@@ -52,7 +52,7 @@ def bsync_dump(root_element, file="example1.xml"):
5252

5353

5454
# Have to manually set the version right now. Align release of bsyncpy to this version.
55-
as_etree.set("version", "2.5.0")
55+
as_etree.set("version", "2.6.0")
5656
output = etree.tostring(as_etree, doctype=doctype, pretty_print=True)
5757
with open(file, 'wb+') as f:
5858
f.write(output)

docs/notebooks/bsync_examples/Reference-PrimarySchool-L100-Audit.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd" version="2.5.0">
2+
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd" version="2.6.0">
33
<Facilities>
44
<Facility ID="Facility-1">
55
<Sites>

docs/notebooks/bsync_examples/Reference-PrimarySchool-L200-Audit.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd" version="2.5.0">
2+
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd" version="2.6.0">
33
<Facilities>
44
<Facility ID="Facility-1">
55
<Sites>

docs/notebooks/bsync_examples/Small-Office-Level-1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ By the end of this notebook, you should:
1616
- Create a minimum viable Level 1 BuildingSync document and verify it validates using the [BuildingSync Use Case Validator](https://buildingsync.net/validator)
1717

1818
## For Reference: Core Concepts and Notation Used
19-
- We will be using BuildingSync version 2.5.0. [Documentation](https://buildingsync.net/documentation/2.5.0). [Github release](https://github.com/BuildingSync/schema/releases/tag/v2.5.0).
19+
- We will be using BuildingSync version 2.6.0. [Documentation](https://buildingsync.net/documentation/2.6.0). [Github release](https://github.com/BuildingSync/schema/releases/tag/v2.6.0).
2020
- BuildingSync is an XML Schema Document (XSD). It defines intended structure. Referring to something as a BuildingSync document typically means the document is intended to conform to the BuildingSync schema.
2121
- An XSD defines a hierarchical or tree-based schema, where elements are 'nested' within other elements. An XML document then looks like nested elements within one another. Similar to HTML, it uses angle brackets `<` and `>` to open and close an element tag. The example below provides a very simple example of an XML document:
2222
```xml
@@ -49,7 +49,7 @@ def bsync_dump(root_element, file="example1.xml"):
4949
as_etree = root_element.toxml()
5050
# Have to manually set the declaration header right now
5151
as_etree.set("xmlns", "http://buildingsync.net/schemas/bedes-auc/2019")
52-
as_etree.set("version", "2.5.0")
52+
as_etree.set("version", "2.6.0")
5353
output = etree.tostring(as_etree, doctype=doctype, pretty_print=True)
5454
with open(file, "wb+") as f:
5555
f.write(output)

docs/notebooks/bsync_examples/Small-Office-Level-2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ By the end of this notebook, you should:
1616
- Create a minimum viable Level 2 BuildingSync document and verify it validates using the [BuildingSync Use Case Validator](https://buildingsync.net/validator)
1717

1818
## For Reference: Core Concepts and Notation Used
19-
- We will be using BuildingSync version 2.5.0. [Documentation](https://buildingsync.net/documentation/2.5.0). [Github release](https://github.com/BuildingSync/schema/releases/tag/v2.5.0).
19+
- We will be using BuildingSync version 2.6.0. [Documentation](https://buildingsync.net/documentation/2.6.0). [Github release](https://github.com/BuildingSync/schema/releases/tag/v2.6.0).
2020
- BuildingSync is an XML Schema Document (XSD). It defines intended structure. Referring to something as a BuildingSync document typically means the document is intended to conform to the BuildingSync schema.
2121
- An XSD defines a hierarchical or tree-based schema, where elements are 'nested' within other elements. An XML document then looks like nested elements within one another. Similar to HTML, it uses angle brackets `<` and `>` to open and close an element tag. The example below provides a very simple example of an XML document:
2222
```xml
@@ -51,7 +51,7 @@ def bsync_dump(root_element, file="example1.xml"):
5151
as_etree = root_element.toxml()
5252
# Have to manually set the declaration header right now
5353
as_etree.set("xmlns", "http://buildingsync.net/schemas/bedes-auc/2019")
54-
as_etree.set("version", "2.5.0")
54+
as_etree.set("version", "2.6.0")
5555
output = etree.tostring(as_etree, doctype=doctype, pretty_print=True)
5656
with open(file, "wb+") as f:
5757
f.write(output)

docs/notebooks/bsync_examples/example-smalloffice-level1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019"
33
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44
xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd"
5-
version="2.5.0">
5+
version="2.6.0">
66
<Facilities>
77
<Facility ID="Facility-1">
88
<Sites>

docs/notebooks/bsync_examples/example-smalloffice-level2.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019"
33
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44
xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../../BuildingSync.xsd"
5-
version="2.5.0">
5+
version="2.6.0">
66
<Facilities>
77
<Facility ID="Facility-1">
88
<Sites>

docs/notebooks/example-with-emissions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<BuildingSync xmlns="http://buildingsync.net/schemas/bedes-auc/2019"
33
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44
xsi:schemaLocation="http://buildingsync.net/schemas/bedes-auc/2019 ../../BuildingSync.xsd"
5-
version="2.4.0">
5+
version="2.6.0">
66
<Facilities>
77
<Facility ID="Facility-1">
88
<Sites>

docs/notebooks/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.poetry]
22
name = "bsync-examples"
33
version = "0.2.0"
4-
description = "Examples for generating BuildingSync files from Python. This currently uses BuildingSync Version 2.5."
4+
description = "Examples for generating BuildingSync files from Python. This currently uses BuildingSync Version 2.6."
55
authors = ["corymosiman12 <[email protected]>", "nllong <[email protected]>"]
66

77
[tool.poetry.dependencies]

docs/release_instructions.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,17 @@ Check out main locally, pull changes, and create a tag and push it
3030
git checkout main && git pull
3131
git tag -a v<version> -m "<message>" [SHA]
3232
```
33-
Where `v<version>` is a valid [semantic version](https://semver.org/) (e.g., `v1.2.3` or `v1.2.3-pr.1`) and `<message>` is the tagging message (e.g. "First official release"). See [Versioning](versioning.md) for more information.
33+
Where `v<version>` is a valid [semantic version](https://semver.org/) (e.g., `v1.2.3` or `v1.2.3-pr.1`) and `<message>` is the tagging message (e.g. "First official release"). [SHA] is used for specific commit (when the tag does not correspond to the latest commit). See [Versioning](versioning.md) for more information.
3434
```bash
3535
# push the tag
3636
git push --tags origin
3737
```
3838

3939
This should trigger a GitHub workflow for building and publishing the release. If publishing a pre-release, you are done. Otherwise, once the release has been successfully published on GitHub, continue.
4040

41+
### Update BuildingSync examples and version references
42+
Walk through all the files and documents in the develop branch to update the version references to the newest release. Update examples in [notebook](https://github.com/BuildingSync/schema/tree/develop-v2/docs/notebooks) and [examples](https://github.com/BuildingSync/schema/tree/develop-v2/examples) corresponding to changes for new release. This will be the first PR for new release, and is prerequisite for updating the website in next step.
43+
4144
### Update BuildingSync Website
4245

4346
At this point the GitHub action for publishing the release should be finished. Now we need to update the docs/data in [this repo](https://github.com/BuildingSync/BuildingSync-website). Read the README in that repository.

0 commit comments

Comments
 (0)