Added more pre-release documentation and email template to RELEASING.md - #1255
Added more pre-release documentation and email template to RELEASING.md#1255m1yag1 wants to merge 1 commit into
Conversation
|
I really don't want the document to be so long. When I'm running a release of a project, I typically We're already being really verbose and prescriptive here in a way that I think is "a bit much". For contrast, here's the entirety of I'll accept that might be too short for a shared project with more maintainers (and we actually have more mechanical steps to list, like the PR process), but doubling the length of a document which already takes a full page-length to My ideal version of our releasing doc for the SDK would be something like... This obviously assumes that we setup a script with the relevant functionality, but given that it's 90% written already, that shouldn't be that hard. I doubt we have full alignment from all current maintainers on exactly what we want this to look like, and I may be an outlier in wanting to be able to If we're going to document a prerelease process as distinct from the normal release process (do we really need to?), I would like it to at least be a separate doc. |
While the two processes are very similar, when I had to go through the pre-release steps it was easier to have them written out in detail. Additionally, I felt having an email template was a nice thing to have.
📚 Documentation preview 📚: https://globus-sdk-python--1255.org.readthedocs.build/en/1255/