Skip to content

Commit

Permalink
Prepare 0.5 release (#556)
Browse files Browse the repository at this point in the history
* prep release

* add changelog
  • Loading branch information
nllong authored Jun 9, 2023
1 parent 84e138f commit f157df3
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 6 deletions.
27 changes: 27 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
Change Log
==========

Version 0.5.0
-------------

## What's Changed
### Exciting New Features 🎉
* Python 3.11 support by @vtnate in https://github.com/urbanopt/geojson-modelica-translator/pull/518
* Add max_electrical_load to building sys-param data by @vtnate in https://github.com/urbanopt/geojson-modelica-translator/pull/530
* Modifications for GHE by @tanushree04 in https://github.com/urbanopt/geojson-modelica-translator/pull/526
* Add Level 1 - 5G DES system by @nllong in https://github.com/urbanopt/geojson-modelica-translator/pull/539
* Set SWH peak to 1/10th of space heating or min 5000W by @nllong in https://github.com/urbanopt/geojson-modelica-translator/pull/542
* Added GHE templates by @JingWang-CUB in https://github.com/urbanopt/geojson-modelica-translator/pull/533
* Add OpenModelica compatibility by @vtnate in https://github.com/urbanopt/geojson-modelica-translator/pull/516
* Modify GHE params by @tanushree04 in https://github.com/urbanopt/geojson-modelica-translator/pull/537
* Enable compile & simulate with OpenModelica in Docker by @vtnate in https://github.com/urbanopt/geojson-modelica-translator/pull/545
### Other Changes
* Specify ports for each time series building in instance template by @vtnate in https://github.com/urbanopt/geojson-modelica-translator/pull/525
* Update license language by @nllong in https://github.com/urbanopt/geojson-modelica-translator/pull/529
* Add MOS file wrapper and size the 5G mass flow rate by @nllong in https://github.com/urbanopt/geojson-modelica-translator/pull/548
* Fixing borefield test breaks due to schema changes by @JingWang-CUB in https://github.com/urbanopt/geojson-modelica-translator/pull/550
* Updating GHE Parameters: Modifying GHE Parameters schema and example files by @tanushree04 in https://github.com/urbanopt/geojson-modelica-translator/pull/551
* Enhance and expand microgrid templates and code by @vtnate in https://github.com/urbanopt/geojson-modelica-translator/pull/549

## New Contributors
* @tanushree04 made their first contribution in https://github.com/urbanopt/geojson-modelica-translator/pull/526

**Full Changelog**: https://github.com/urbanopt/geojson-modelica-translator/compare/0.4.1...v0.5.0

Version 0.4.1
-------------
## What's Changed
Expand Down
8 changes: 5 additions & 3 deletions docs/developer_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,12 @@ the runner to work locally.
Release Instructions
--------------------

* Bump version to <NEW_VERSION> in setup.py (use semantic versioning).
* Bump version to <NEW_VERSION> in pyproject.toml (use semantic versioning).
* Run :code:`poetry update` to ensure the lock file is up to date with the latest "pinned" dependencies.
* Run :code:`pre-commit run --all-files` to ensure code is formatted properly.
* Create a PR into develop with the updated version.
* Go to `GitHub release page <https://github.com/urbanopt/geojson-modelica-translator/tags>`_ and create a temp release tag to generate the CHANGELOG.
* Copy in the CHANGELOG entries that are relevant to the new version, commit, push, and merge after CI passes.
* Create a PR against develop into main.
* After main branch passes, merge and checkout the main branch. Build the distribution using the following code:

Expand Down Expand Up @@ -301,8 +305,6 @@ Release Instructions
./docs/publish_docs.sh
* Run :code:`git push origin <new_tag_version>`
* Go to `GitHub release page <https://github.com/urbanopt/geojson-modelica-translator/tags>`_ and convert the tag to a release.
* Copy in the CHANGELOG entries that are relevant to the new version.
* Verify new documentation on the `docs website <https://docs.urbanopt.net/geojson-modelica-translator/>`_.

Code Documentation
Expand Down
6 changes: 3 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f157df3

Please sign in to comment.