-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Updates changelog and add release doc
- Loading branch information
1 parent
1afa3b8
commit aefeb39
Showing
2 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
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,46 @@ | ||
# How to release | ||
|
||
This is documenting the release process. | ||
|
||
|
||
## Git flow & CHANGELOG.md | ||
|
||
Make sure the CHANGELOG.md is up to date and follows the http://keepachangelog.com guidelines. | ||
Start the release with git flow: | ||
```batch | ||
git flow release start vYYYYMMDD | ||
``` | ||
Now update the [CHANGELOG.md](/CHANGELOG.md) `[Unreleased]` section to match the new release version. | ||
Also update the `version` string in the [setup.py](/setup.py) file. Then commit and finish release. | ||
```batch | ||
git commit -a -m ":bookmark: vYYYYMMDD" | ||
git flow release finish | ||
``` | ||
Push everything, make sure tags are also pushed: | ||
```batch | ||
git push | ||
git push origin master:master | ||
git push --tags | ||
``` | ||
|
||
## Publish to PyPI | ||
Build it: | ||
```batch | ||
python setup.py sdist bdist_wheel | ||
``` | ||
Check archive content: | ||
```batch | ||
tar -tvf dist\pycaw-*.tar.gz | ||
``` | ||
Upload: | ||
```batch | ||
twine upload dist\pycaw-*.tar.gz | ||
``` | ||
|
||
## GitHub | ||
|
||
Got to GitHub [Release/Tags](https://github.com/AndreMiras/pycaw/tags), click "Add release notes" for the tag just created. | ||
Add the tag name in the "Release title" field and the relevant CHANGELOG.md section in the "Describe this release" textarea field. | ||
|
||
## Post release | ||
Update the [setup.py](/setup.py) `version string` with `YYYYMMDD.dev0`. |