forked from auracaster/pyalsaaudio
31 lines
811 B
Markdown
31 lines
811 B
Markdown
# Make a new release
|
|
|
|
Create and push a tag naming the version (i.e. 0.11.1):
|
|
|
|
git tag 0.11.1
|
|
git push origin 0.11.1
|
|
|
|
This should trigger a build via a github actions and publish pre-built binaries to pypi.org
|
|
|
|
# Publish the documentation
|
|
|
|
All commits to main should trigger a rebuild of the documentation.
|
|
|
|
## Historical background
|
|
|
|
The documentation is published through the `gh-pages` branch.
|
|
|
|
To publish the documentation, you need to clone the `gh-pages` branch of this repository into
|
|
`doc/gh-pages`. In `doc`, do:
|
|
|
|
git clone -b gh-pages git@github.com:larsimmisch/pyalsaaudio.git gh-pages
|
|
|
|
(This is a bit of a hack)
|
|
|
|
Once that is set up, you can publish new documentation using:
|
|
|
|
make publish
|
|
|
|
Be careful when new files are generated, however, you will have to add them
|
|
manually to git.
|