-
-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Release 0.4.0.pre1 * update RELEASING.md * Fix release naming from .pre to .dev
- Loading branch information
Showing
6 changed files
with
878 additions
and
26 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Changelog | ||
========= | ||
Historical pyHS100 changelog | ||
============================ | ||
|
||
0.3.5 (2019-04-13) | ||
------------ | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters