python-kasa · rytilahti · Jul 28, 2020 · Jul 28, 2020 · Jul 28, 2020 · Jul 28, 2020
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG → HISTORY.md b/CHANGELOG → HISTORY.md
@@ -1,5 +1,5 @@
-Changelog
-=========
+Historical pyHS100 changelog
+============================
 
 0.3.5 (2019-04-13)
 ------------

diff --git a/HOWTO_RELEASE b/HOWTO_RELEASE
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ Location:     {'latitude': XXXX, 'longitude': XXXX}
 Current state: {'total': 133.082, 'power': 100.418681, 'current': 0.510967, 'voltage': 225.600477}
 ```
 
-Use `kasa --help` to get list of all available commands.
+Use `kasa --help` to get list of all available commands, or alternatively, [consult the documentation](https://python-kasa.readthedocs.io/en/latest/cli.html).
 
 ## Basic controls
 

diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,63 @@
+1. Set release information
+
+```bash
+# export PREVIOUS_RELEASE=$(git describe --abbrev=0)
+export PREVIOUS_RELEASE=0.3.5 # generate the full changelog since last pyhs100 release
+export NEW_RELEASE=0.4.0.pre1
+```
+
+2. Update the version number
+
+```bash
+poetry version $NEW_RELEASE
+```
+
+3. Generate changelog
+
+```bash
+# gem install github_changelog_generator --pre
+# https://github.com/github-changelog-generator/github-changelog-generator#github-token
+export CHANGELOG_GITHUB_TOKEN=token
+github_changelog_generator --base HISTORY.md --user python-kasa --project python-kasa --since-tag $PREVIOUS_RELEASE --future-release $NEW_RELEASE -o CHANGELOG.md
+```
+
+3. Write a short and understandable summary for the release.
+
+4. Commit the changed files
+
+```bash
+git commit -av
+```
+
+5. Create a PR for the release.
+
+6. Get it merged, fetch the upstream master
+
+```bash
+git checkout master
+git fetch upstream
+git rebase upstream/master
+```
+
+5. Tag the release (add short changelog as a tag commit message), push the tag to git
+
+```bash
+git tag -a $NEW_RELEASE
+git push upstream $NEW_RELEASE
+```
+
+7. Upload new version to pypi
+
+If not done already, create an API key for pypi (https://pypi.org/manage/account/token/) and configure it:
+```
+poetry config pypi-token.pypi <token>
+```
+
+To build & release:
+
+```bash
+poetry build
+poetry publish
+```
+
+8. Click the "Draft a new release" button on github, select the new tag and copy & paste the changelog into the description.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-kasa"
-version = "0.4.0.dev0"
+version = "0.4.0.dev1"
 description = "Python API for TP-Link Kasa Smarthome devices"
 license = "GPL-3.0-or-later"
 authors = ["Your Name <you@example.com>"]