Skip to content

Commit

Permalink
Bumped version to 1.0.3.
Browse files Browse the repository at this point in the history
  • Loading branch information
john-hen committed May 5, 2021
1 parent 5bc7416 commit 2ac0d13
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 6 deletions.
6 changes: 3 additions & 3 deletions deploy/release.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Steps to take when releasing a new version:
* Bump version number and enter current date in `mph/__init__.py`.
* Add the release notes to `docs/releases.md`.
* Add a dedicated commit for the version bump.
* Add the release notes for this version in the same commit.
* Tag the commit with the version number, for example: `git tag -a v1.0.2`.
* Tag the commit with the version number, for example: `git tag -a v1.0.3`.
* Enter the release notes as an annotation.
* Push the commit (but not the tag): `git push origin main`.
* Check that documentation built successfully on Read-the-Docs.
* Activate, but hide, the build for the release tag on Read-the-Docs.
* Publish to PyPI by running `deploy/publish.py`.
* Check that meta information is correct on PyPI.
* Then push the tag: `git push --tags`.
* Force the `stable` branch to new release tag: `git branch -f stable`.
* Same for the current documentation branch: `git branch -f 1.0`.
* Push both branches upstream, e.g.: `git push origin stable`.
* Activate, but hide, the build for the release tag on Read-the-Docs.
* Create a new release on GitHub and add the release notes.
12 changes: 12 additions & 0 deletions docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Releases

## 1.0.3
* [Published](https://pypi.org/project/MPh/1.0.3) on May 5, 2021.
* Fixes: [`Client.remove()`](https://mph.readthedocs.io/en/1.0/api/mph.Client.html#mph.Client.remove) did not accept model by name.
* Fixes: Node names were not escaped when creating new features.
* Fixes: [`Model.save()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.save) failed when `format` given, but not `path`.
* Fixes: [`Model.save()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.save) without `path` given did not save new models.
* Fixes: [`Model.parameters(evaluate=True)`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.parameters) returned strings, not numbers.
* Fixes off-by-one error when passing `inner` indices to [`Model.evaluate()`](https://mph.readthedocs.io/en/1.0/api/mph.Model.html#mph.Model.evaluate).
* Comsol expects 1-based indices, as opposed to Python's 0-based indexing.
* Adds missing built-in group `'couplings'`.
* [`mph.start()`](https://mph.readthedocs.io/en/1.0/api/mph.start.html) now returns existing client instance on subsequent calls.

## 1.0.2
* [Published](https://pypi.org/project/MPh/1.0.2) on April 28, 2021.
* Assigns more typical tag names when creating new model features.
Expand Down
4 changes: 2 additions & 2 deletions mph/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# Meta information
__title__ = 'MPh'
__version__ = '1.0.2'
__date__ = '2021–04–28'
__version__ = '1.0.3'
__date__ = '2021–05–05'
__author__ = 'John Hennig'
__copyright__ = 'John Hennig'
__license__ = 'MIT'
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ classifiers = [

[tool.flit.metadata.requires-extra]
doc = ['Sphinx', 'Furo', 'MyST-parser', 'CommonMark']
test = ['pyTest', 'pyTest-cov', 'coverage-badge']
test = ['pyTest', 'pyTest-cov', 'coverage-badge', 'flake8']

[tool.flit.metadata.urls]
Documentation = 'https://mph.readthedocs.io'
Expand Down

0 comments on commit 2ac0d13

Please sign in to comment.