From 68a4cf240d7cf3044897989bca93934c562ef084 Mon Sep 17 00:00:00 2001 From: Teemu R Date: Mon, 20 Nov 2017 23:27:08 +0100 Subject: [PATCH] bump to 0.3.2, add RELEASING.md for describing the process (#126) --- CHANGELOG.md | 32 ++++++++++++++++++++++++++++++++ RELEASING.md | 23 +++++++++++++++++++++++ miio/version.py | 2 +- 3 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 RELEASING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index eab1b90f5..ea8cd0bef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,37 @@ # Change Log +## [0.3.2](https://github.com/rytilahti/python-miio/tree/0.3.2) + +This release includes small improvements for powerstrip and vacuum support. +Furthermore this is the first release with proper documentation. +Generated docs are available at https://python-miio.readthedocs.io - patches to improve them are more than welcome! + +Improvements: +* Powerstrip: expose correct load power, works also now without cloud connectivity +* Vacuum: added ability to reset consumable states +* Vacuum: exposes time left before next sensor clean-up + +[Full Changelog](https://github.com/rytilahti/python-miio/compare/0.3.1...0.3.2) + +**Closed issues:** + +- philips.light.ceiling Unsupported device found! [\#118](https://github.com/rytilahti/python-miio/issues/118) +- Xiaomi Philips ceiling light automation [\#116](https://github.com/rytilahti/python-miio/issues/116) +- Unsupported device found [\#112](https://github.com/rytilahti/python-miio/issues/112) +- PM2.5 Faster Readout [\#111](https://github.com/rytilahti/python-miio/issues/111) + +**Merged pull requests:** + +- add pure text LICENSE [\#125](https://github.com/rytilahti/python-miio/pull/125) ([rytilahti](https://github.com/rytilahti)) +- Add GPLv3 license [\#124](https://github.com/rytilahti/python-miio/pull/124) ([pluehne](https://github.com/pluehne)) +- Don’t require typing with Python 3.5 and newer [\#123](https://github.com/rytilahti/python-miio/pull/123) ([pluehne](https://github.com/pluehne)) +- Powerstrip fixes [\#121](https://github.com/rytilahti/python-miio/pull/121) ([rytilahti](https://github.com/rytilahti)) +- Added time left for recommended sensor cleaning [\#119](https://github.com/rytilahti/python-miio/pull/119) ([bbbenji](https://github.com/bbbenji)) +- Load power of the PowerStrip fixed and removed from the Plug [\#117](https://github.com/rytilahti/python-miio/pull/117) ([syssi](https://github.com/syssi)) +- Reset consumable by name [\#115](https://github.com/rytilahti/python-miio/pull/115) ([mrin](https://github.com/mrin)) +- Model name of the Xiaomi Philips Ceiling Lamp updated [\#113](https://github.com/rytilahti/python-miio/pull/113) ([syssi](https://github.com/syssi)) +- Update apidocs for sphinx-generated documentation, which follows at l… [\#93](https://github.com/rytilahti/python-miio/pull/93) ([rytilahti](https://github.com/rytilahti)) + ## [0.3.1](https://github.com/rytilahti/python-miio/tree/0.3.1) (2017-11-01) New supported devices: diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 000000000..905a0c0cc --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,23 @@ +1. Update the version number + +nano miio/version.py + +2. Generate changelog since the last release + +~/.gem/ruby/2.4.0/bin/github_changelog_generator --user rytilahti --project python-miio --since-tag 0.3.0 -o newchanges + +3. Copy the changelog block over to CHANGELOG.md and write a short, understandable short changelog + +4. Commit modified CHANGELOG.md + +5. Tag a release (and add short changelog as a tag commit message) + +tag -a 0.3.1 + +6. Push to git + +git push --tags + +7. Upload new version to pypi + +python setup.py sdist bdist_wheel upload diff --git a/miio/version.py b/miio/version.py index 9218d345d..3596efecd 100644 --- a/miio/version.py +++ b/miio/version.py @@ -1,2 +1,2 @@ # flake8: noqa -__version__ = "0.3.1" +__version__ = "0.3.2"