document release steps #4829
document release steps #4829
Conversation
docs/manual/releasing.rst
Outdated
| 2. Create a GPG-signed annotated tag (``git commit -a -s``); I usually just use | ||
| exactly the same commit message as the actual release commit above. | ||
|
|
||
| 3. Push your release commit to git master and your tag. |
There was a problem hiding this comment.
Do you need to say you're pushing straight to upstream rather than your fork? Would be good to give command line here too.
| exactly the same commit message as the actual release commit above. | ||
|
|
||
| 3. Push your release commit to git master and your tag. | ||
|
|
There was a problem hiding this comment.
Before creating the release, we should check the action that builds the wheels and pushes these to test.pypi. This is triggered by the tag being pushed. If that's green then we can create the release.
There was a problem hiding this comment.
Oh! I think I knew this, but I totally forgot to do it for the most recent release. I will make a note.
|
Ok, take a look now and see what you think. |
|
|
||
| .. bash:: | ||
|
|
||
| git push origin vX.XX.XX |
There was a problem hiding this comment.
For me, origin is my fork, upstream is the main qtile repo...
There was a problem hiding this comment.
This is the risk of writing explicit git commands :). Should I drop them? Or what do you prefer?
There was a problem hiding this comment.
Maybe remove the example and be more explicit in line 22 e.g. adding something like ... as opposed to your fork
docs/manual/releasing.rst
Outdated
|
|
||
| 8. send a mail to qtile-dev@googlegroups.com; I sometimes just use | ||
| git-send-email with the release commit, but a manual copy/paste of the | ||
| release notes into an e-mail is fine as well. |
There was a problem hiding this comment.
A message via IRC/Discord would be good too.
I realized a lot of this is just in my bash history and stuff I've stumbled over. I'm sure other people know this, I'm mostly just writing it down for reference next time I need to tag a release. I didn't add it to the table of contents or anything since I don't think any users really care, but I can if people think it's useful. Signed-off-by: Tycho Andersen <tycho@tycho.pizza>
I realized a lot of this is just in my bash history and stuff I've stumbled over. I'm sure other people know this, I'm mostly just writing it down for reference next time I need to tag a release.
I didn't add it to the table of contents or anything since I don't think any users really care, but I can if people think it's useful.