Add automatic release on PyPI #729
Conversation
mrbean-bremen
commented
Oct 8, 2022
mrbean-bremen
commented
- triggered on publishing a GH release
- includes creation of release documentation
- add PR templates, adapt issue templates
- minor documentation changes
- triggered on publishing a GH release - includes creation of release documentation - add PR templates, adapt issue templates - minor documentation changes
|
|
||
| - name: Copy and commit release documentation | ||
| run: | | ||
| cp -r main/gh-pages/* doc/release |
There was a problem hiding this comment.
Ahh interesting, the docs are published in gh-pages.
In the future I suggest to use readthedocs.io, which builds the docs automatically for releases and even PRs for preview. 👍
There was a problem hiding this comment.
Until now, I have always done it this way (including in pytest-order), but I will have a look at readthedocs in this case, thanks. Not for this release, though...
There was a problem hiding this comment.
The preview feature is indeed something I am missing in gh-pages, so I will definitely check this out!
There was a problem hiding this comment.
Actually, setting up ReadTheDocs is very easy, as it turned out - I will probably change this before the release. Maybe tomorrow if I get to it... The PR preview is too good a feature to miss, and as far as I understand, there is literally nothing to do in the release workflow (apart from removing the GH Pages stuff again). Thanks for the tip!
There was a problem hiding this comment.
Sure thing!
The preview is not enabled by default, you need to go into advanced settings and enable it:
There was a problem hiding this comment.
Thanks, I noticed this. A bit odd that this cannot be configured in the configuration file...
- use build instead of setup - changed token name
…elease - includes creation of release documentation - add PR templates, adapt issue templates - minor documentation changes
2 participants
