8000 Release 0.4.0.dev1 (#93) · sberkovitz/python-kasa@c67bda8 · GitHub
[go: up one dir, main page]
Skip to content

Commit c67bda8

Browse files
rytilahtirytilahti
authored
Release 0.4.0.dev1 (python-kasa#93)
* Release 0.4.0.pre1 * update RELEASING.md * Fix release naming from .pre to .dev
1 parent 6844166 commit c67bda8

File tree

6 files changed

+878
-26
lines changed

6 files changed

+878
-26
lines changed

‎CHANGELOG.md

Lines changed: 811 additions & 0 deletions
Large diffs are not rendered by default.

‎CHANGELOG renamed to ‎HISTORY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Changelog
2-
=========
1+
Historical pyHS100 changelog
2+
============================
33

44
0.3.5 (2019-04-13)
55
------------

‎HOWTO_RELEASE

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Location: {'latitude': XXXX, 'longitude': XXXX}
4545
Current state: {'total': 133.082, 'power': 100.418681, 'current': 0.510967, 'voltage': 225.600477}
4646
```
4747

48-
Use `kasa --help` to get list of all available commands.
48+
Use `kasa --help` to get list of all available commands, or alternatively, [consult the documentation](https://python-kasa.readthedocs.io/en/latest/cli.html).
4949

5050
## Basic controls
5151

‎RELEASING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
1. Set release information
2+
3+
```bash
4+
# export PREVIOUS_RELEASE=$(git describe --abbrev=0)
5+
export PREVIOUS_RELEASE=0.3.5 # generate the full changelog since last pyhs100 release
6+
export NEW_RELEASE=0.4.0.pre1
7+
```
8+
9+
2. Update the version number
10+
11+
```bash
12+
poetry version $NEW_RELEASE
13+
```
14+
15+
3. Generate changelog
16+
17+
```bash
18+
# gem install github_changelog_generator --pre
19+
# https://github.com/github-changelog-generator/github-changelog-generator#github-token
20+
export CHANGELOG_GITHUB_TOKEN=token
21+
github_changelog_generator --base HISTORY.md --user python-kasa --project python-kasa --since-tag $PREVIOUS_RELEASE --future-release $NEW_RELEASE -o CHANGELOG.md
22+
```
23+
24+
3. Write a short and understandable summary for the release.
25+
26+
4. Commit the changed files
27+
28+
```bash
29+
git commit -av
30+
```
31+
32+
5. Create a PR for the release.
33+
34+
6. Get it merged, fetch the upstream master
35+
36+
```bash
37+
git checkout master
38+
git fetch upstream
39+
git rebase upstream/master
40+
```
41+
42+
5. Tag the release (add short changelog as a tag commit message), push the tag to git
43+
44+
```bash
45+
git tag -a $NEW_RELEASE
46+
git push upstream $NEW_RELEASE
47+
```
48+
49+
7. Upload new version to pypi
50+
51+
If not done already, create an API key for pypi (https://pypi.org/manage/account/token/) and configure it:
52+
```
53+
poetry config pypi-token.pypi <token>
54+
```
55+
56+
To build & release:
57+
58+
```bash
59+
poetry build
60+
poetry publish
61+
```
62+
63+
8. Click the "Draft a new release" button on github, select the new tag and copy & paste the changelog into the description.

‎pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "python-kasa"
3-
version = "0.4.0.dev0"
3+
version = "0.4.0.dev1"
44
description = "Python API for TP-Link Kasa Smarthome devices"
55
license = "GPL-3.0-or-later"
66
authors = ["Your Name <you@example.com>"]

0 commit comments

Comments
 (0)
0