Merge pull request #19 from BuildingSync/develop

prep for 0.3.0-alpha.0 release

Author: nllong

.github/workflows/ci.yml

@@ -12,31 +12,49 @@ jobs:
         python-version: [3.7, 3.8]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Display Python version
-      run: python -c "import sys; print(sys.version)"
-
-    - name: Install poetry
-      uses: abatilo/actions-poetry@v2.0.0
-
-    - name: Install poetry (and update) and pre-commit
-      run: | 
-        poetry update
-        poetry run pre-commit install
-
-    - name: Run pre-commit
-      run: poetry run pre-commit run --all-files
-
-    - name: Run tests
-      run: poetry run pytest
-
-    - name: Run Generator (BuildingSync 2.4)
-      run: |
-        curl -L -o bsyncpy/BuildingSync-2.4.xsd https://github.com/BuildingSync/schema/releases/download/v2.4.0/BuildingSync.xsd
-        cd bsyncpy
-        poetry run python bsyncpy_generator.py BuildingSync-2.4.xsd
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2.0.0
+
+      - name: Install poetry (and update) and pre-commit
+        run: |
+          poetry update
+          poetry run pre-commit install
+
+      - name: Run pre-commit
+        run: poetry run pre-commit run --all-files
+
+      - name: Run tests
+        run: poetry run pytest
+
+      - name: Run Generator (BuildingSync 2.3)
+        run: |
+          curl -L -o bsyncpy/BuildingSync-2.3.xsd https://github.com/BuildingSync/schema/releases/download/v2.3.0/BuildingSync.xsd
+          cd bsyncpy
+          poetry run python bsyncpy_generator.py BuildingSync-2.3.xsd
+
+      - name: Run Generator (BuildingSync 2.4)
+        run: |
+          curl -L -o bsyncpy/BuildingSync-2.4.xsd https://github.com/BuildingSync/schema/releases/download/v2.4.0/BuildingSync.xsd
+          cd bsyncpy
+          poetry run python bsyncpy_generator.py BuildingSync-2.4.xsd
+
+      - name: Run Generator (BuildingSync Develop V2)
+        run: |
+          curl -L -o bsyncpy/BuildingSync-develop-v2.xsd https://raw.githubusercontent.com/BuildingSync/schema/develop-v2/BuildingSync.xsd
+          cd bsyncpy
+          poetry run python bsyncpy_generator.py BuildingSync-develop-v2.xsd
+
+      - name: Run Generator (BuildingSync Develop V3)
+        run: |
+          curl -L -o bsyncpy/BuildingSync-develop-v3.xsd https://raw.githubusercontent.com/BuildingSync/schema/develop-v3/BuildingSync.xsd
+          cd bsyncpy
+          poetry run python bsyncpy_generator.py BuildingSync-develop-v3.xsd

.gitignore

@@ -10,4 +10,4 @@ dist
 BuildingSync.xsd
 BuildingSync-*.xsd
 example.py
-output.xml
+output.xml

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 21.9b0 # Replace by any tag/version: https://github.com/psf/black/tags
+    rev: 22.3.0
     hooks:
       - id: black
         language_version: python3 # Should be a command that runs python3.6+

CHANGELOG.md

@@ -1,4 +1,9 @@
-# Version 0.2.0 (Unreleased)
+# Version 0.3.0.alpha.0
+
+* Generated for BuildingSync 2.5 (which is currently develop-v2)
+    * Added GHG emission metrics
+
+# Version 0.2.0
 
 * Generated for BuildingSync 2.4
 * Renamed project folder to bsyncpy to follow Python package conventions

README.md

@@ -61,13 +61,15 @@ Check out our example Jupyter Notebook [here](https://nbviewer.jupyter.org/githu
 
 * See the notes above on downloading and generating the new bsync.py file. 
 * Bump version in `pyproject.toml` file
-* Add CHANGELOG entry
+* Add/update CHANGELOG entry
 * Update (or add) generator test in `.github/ci.yml`
 * Update this README with the latest version of testing.
 
 ## Releasing New Version
 
-* Merge everything down to `main`
+* Bump version using poetry by calling `poetry version X.Y.Z`
+* Make sure CHANGELOG.md is up to date
+* Create pull request to merge `develop` to `main`
 * `git tag <version>`. Version in the form of vX.Y.Z.
 * `git push --tags`.
 * Go to GitHub and convert the tag to a release.