You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**NOTE**: You will need to be _off_ the NREL VPN to import a schema, otherwise you'll get an error related to http://www.gbxml.org/schema}Area' as the gbXML schema cannot be imported when on the NREL VPN.
56
+
**NOTE**: You will need to be _off_ the NREL VPN to import a schema, otherwise you'll get an error related to `http://www.gbxml.org/schema}Area'` as the gbXML schema cannot be imported when on the NREL VPN.
57
57
58
58
### Pre-commit
59
59
60
-
This project used `pre-commit<https://pre-commit.com/>`\_ to ensure code consistency. To enable pre-commit, run the following from the command line.
60
+
This project uses [pre-commit](https://pre-commit.com/) to ensure code consistency. To enable pre-commit, run the following from the command line:
61
61
62
62
```bash
63
63
pip install pre-commit
@@ -72,17 +72,18 @@ pre-commit run --all-files
72
72
73
73
### Testing
74
74
75
-
- To run test:
75
+
To run tests:
76
76
77
-
```bash
78
-
./manage.py test
79
-
```
77
+
```bash
78
+
./manage.py test
79
+
```
80
80
81
-
- To calculate coverage:
82
-
```bash
83
-
coverage run --source='.' manage.py test
84
-
coverage report
85
-
```
81
+
To calculate coverage:
82
+
83
+
```bash
84
+
coverage run --source='.' manage.py test
85
+
coverage report
86
+
```
86
87
87
88
## Usage
88
89
@@ -113,9 +114,10 @@ The validator page allows users to validate XMLs against the BuildingSync schema
113
114
114
115
There is also a validator endpoint to validate XML files against the BuildingSync schema and its public use cases.
115
116
116
-
#### SINGLE XML
117
+
#### Single XML
118
+
119
+
**Request**: POST to `https://buildingsync.net/api/validate`
117
120
118
-
Request: POST to https://buildingsync.net/api/validate
119
121
Use form-data to specify the following parameters for schema version and XML file: `schema_version` and `file`.
120
122
121
123
Example Response:
@@ -155,9 +157,10 @@ Example Response:
155
157
}
156
158
```
157
159
158
-
#### ZIP with multiple XMLs
160
+
#### ZIP with Multiple XMLs
161
+
162
+
**Request**: POST to `https://buildingsync.net/api/validate`
159
163
160
-
Request: POST to https://buildingsync.net/api/validate
161
164
Use form-data to specify the following parameters for schema version and XML file: `schema_version` and `file`.
162
165
163
166
Example Response:
@@ -238,33 +241,35 @@ To parse and map a new BEDES version:
238
241
239
242
1. Download the `bedes_online_dictionary_uuid-lo.xml` and the `bedes_online_dictionary_uuid-terms.xml` files from the BEDES website.
240
243
241
-
1. Place these new BEDES XMLs in the lib/bedes/vX.X directory. vX.X refers to the BEDES version here.
244
+
2. Place these new BEDES XMLs in the `lib/bedes/vX.X` directory. `vX.X` refers to the BEDES version here.
242
245
243
-
1. Parse the BEDES XMLs into a JSON file and map the BEDES terms to the BuildingSync attributes:
246
+
3. Parse the BEDES XMLs into a JSON file and map the BEDES terms to the BuildingSync attributes:
Note that the bedes_version contains a `v`, ex: v2.2.
251
-
This will create a bedes_vX.X.json`file in the lib/bedes/vX.X directory. It will also create 2 CSV files:`bedes-mappings-enumerations.csv`and`bedes-mappings-terms.csv` in the lib/bedes/vX.X/schemaX.X directory.
253
+
Note that the `bedes_version` contains a `v`, ex: `v2.2`.
254
+
This will create a `bedes_vX.X.json`file in the `lib/bedes/vX.X` directory. It will also create 2 CSV files:`bedes-mappings-enumerations.csv`and`bedes-mappings-terms.csv` in the `lib/bedes/vX.X/schemaX.X` directory.
252
255
253
-
_Note_ — The BEDES terms must be mapped for each version of the BuildingSync schema by calling the python manage.py bedes` command above.
256
+
**Note**: The BEDES terms must be mapped for each version of the BuildingSync schema by calling the `python manage.py bedes` command above.
254
257
255
-
1. Copy the generated bedes files to the git repo on the production server. The command will be something like:
258
+
4. Copy the generated bedes files to the git repo on the production server. The command will be something like:
Note that you must run this command without the --save_to_db flag first, in order to create the CSV files.
271
+
272
+
Note that you must run this command without the `--save_to_db` flag first, in order to create the CSV files.
268
273
269
274
### Admin Interface
270
275
@@ -284,7 +289,7 @@ Follow these steps to add a new schema version to the selection tool:
284
289
7. Create PR and merge with the changes.
285
290
8. Reparse BEDES terms to map them to the new schema following the steps in the BEDES section above.
286
291
9. Deploy website on production.
287
-
10. If needed, update CHANGELOG and create PR from develop to main for new release of this site (see [release_instructions.md](docs/release_instructions.md)).
292
+
10. If needed, update CHANGELOG and create PR from develop to main for new release of this site (see [Release Instructions](docs/release_instructions.md)).
Copy file name to clipboardExpand all lines: docs/release_instructions.md
+7-18Lines changed: 7 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,21 +3,10 @@
3
3
Follow the list below for a new release:
4
4
5
5
1. Copy the corresponding schema file into `bsyncviewer/lib/buildingsync_schemas/` and rename it
6
-
2. Update version file (/app_version.txt). Update version to next appropriate version. Always use MAJOR.MINOR.RELEASE.
7
-
3. Run the `docs/scripts/change_log.py` script and add the changes to the CHANGELOG.md file for the range of time between last release and this release. Only add the _Closed Issues_. Also make sure that all the pull requests have a related Issue in order to be included in the change log.
4. Paste the results (remove unneeded Accepted Pull Requests) into the CHANGELOG.md. Make sure to cleanup the formatting if needed.
14
-
5. Once develop passes, create a new PR from develop to main.
15
-
6. Draft new Release from Github (https://github.com/BuildingSync/BuildingSync-website/releases).
16
-
17
-
```bash
18
-
git checkout main && git pull
19
-
git tag -a v<version> -m "<message>" [SHA]
20
-
git push --tags origin
21
-
```
22
-
23
-
Include list of changes since previous release in `<message>` (i.e., the content in the CHANGELOG.md). [SHA] is used for specific commit (when the tag does not correspond to the latest commit).
6
+
2. Create a branch for the release prep (e.g., `release/v1.3.0-prep`)
7
+
3. Update version file (/app_version.txt). Update version to next appropriate version. Always use MAJOR.MINOR.RELEASE.
8
+
4. Run `pre-commit run --all-files` locally, and commit changes.
9
+
5. Within GitHub, draft a new release and autogenerate the change log (https://github.com/BuildingSync/BuildingSync-website/releases). Copy the changes into the CHANGELOG.md file. Clean up any items that are not relevant to the release.
10
+
6. Create a PR from the release prep branch to develop. Request reviews and merge once approved.
11
+
7. From command line, merge latest develop into latest main `git checkout main; git pull; git merge --ff-only origin develop`. This will point the HEAD of main to latest develop. Then push the main branch to GitHub with `git push`, which may require a developer with elevated privileges to push to main.
12
+
8. Back on GitHub create a new tag in GitHub against main and copy the change log notes into the tag description.
0 commit comments