Document how to release #765
Conversation
|
|
||
| With the latest main branch checked out locally, tag the release:: | ||
|
|
||
| VERSION=x.y.z |
There was a problem hiding this comment.
This is assuming you have the main repo set as your origin remote rather than your fork, doesn't it? I'd find this confusing.
Any reason not to use the GitHub UI for tagging a release? It gives you a nice interface for making release notes (also seems to be some new features for automating the generation of release notes), but I haven't looked into it .
There was a problem hiding this comment.
Ah, I see, there's a test pypi bit. Is that necessary? I mean, we spend a lot of time making tests and CI workflows so we don't have to worry about this stuff. Personally I wouldn't bother with checking stuff out locally, I don't see what it gets us on top of all the testing we already do.
|
@jeromekelleher you are right, we should be aiming to do all of the release steps without using a local machine. We already test the artifacts using the scripts I documented here (see https://github.com/pystatgen/sgkit/blob/main/.github/workflows/wheels.yml), so we could make the release via the GitHub UI as you suggest. The only step that still needs to be done from a local machine is the documentation, but we should add that to the GitHub action too. I've opened #768, which we should do as a part of (or before) the next release. I'm closing this PR. |
Fixes #691