Condense release guide #393
Conversation
There was a problem hiding this comment.
I know that my English prose is not particularly terse, well my English is 💩 overall, and I use ChatGPT too to make it look better.
However, it seems like this PR doesn't just condense the content but also removes some of it. I've spotted a few removals, commented just one in the review. I'm not sure why parts have been removed, if it's ChatGPT doing its thing or if it was done manually. Having to diff the content is a bit tedious.
Releasing is one of the most critical tasks of the maintainer's role. I wrote this guide as I wanted to avoid new maintainers being in the position I was when I joined the group. I had to ask around to find out what needed to be done to make a release. I didn't feel very secure when I had to release Panel the first time. I'd like to make sure a PR touching this part of the operating guide improves it.
| ``` | ||
|
|
||
| ```{tip} | ||
| You can tag a release from any branch, not necessarily from the main one. This is useful if you have to maintain multiple versions simultaneously (e.g., 2.* and 3.*). |
|
|
||
| 5. **Final Release** | ||
| - Confirm the last development release's stability, preferably with multiple reviews. | ||
| - Bump the version in relevant files to the final number (e.g., `v1.9.6`). |
There was a problem hiding this comment.
This is unfortunately wrong, we release by creating a tag and pushing it to the repo, not by bumping a version in a file.
|
It's ChatGPT removing content. (my English is also 💩 overall :P)
I agree, and I'm hoping it can be streamlined (ideally, after writing the changelog, everything else is automated). In the meantime while automation is in the distance, I personally like these tutorials that's just stepping thru copy/pasting snippets https://github.com/xarray-contrib/xskillscore/blob/main/HOWTORELEASE.rst |
I used ChatGPT to generate this.