Skip to content

Commit

Permalink
📝 Updates changelog and add release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreMiras committed Apr 16, 2022
1 parent 1afa3b8 commit aefeb39
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

## [Unreleased]
- Fixed GetAllDevices() COMError, refs #15, #28 and #30 (@micolous and @reversefold)
- New IAudioSessionEvents callbacks support, refs #27, #36 (@TurboAnonym)
- IAudioSessionControl GetState fix, refs #32, #37 (@TurboAnonym)
- Adding AudioUtilities.GetMicrophone(), refs #39 (@alebzk)
- Reorganize / Split the pycaw.pycaw file in modules and subpackages, refs #38 (@TurboAnonym)
- OnSessionCreated support + Wrapper for callbacks, refs #40 (@TurboAnonym)
- "Magic" module, easy session control, refs #42 (@TurboAnonym)

## [20190904]
- Fixed enum34 dependency, refs #17 (@mmxfguerin)
Expand Down
46 changes: 46 additions & 0 deletions docs/Release.md
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`.

0 comments on commit aefeb39

Please sign in to comment.