update Making Releases in dev guide (hotfixes too) #8795 #8877
Conversation
pdurbin
added this to On Deck 🛎
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
via automation
scolapasta
moved this from On Deck 🛎
to Review 🔎
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
scolapasta
moved this from Review 🔎
to This Sprint 🏃
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
scolapasta
moved this from This Sprint 🏃
to Next Sprint 🏃♀️
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
pdurbin
moved this from Next Sprint 🏃♀️
to Review 🔎
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
scolapasta
moved this from Review 🔎
to This Sprint 🏃♀️
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
pdurbin
moved this from This Sprint 🏃♀️
to Review 🔎
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
scolapasta
moved this from Review 🔎
to This Sprint 🏃♀️
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
landreev
moved this from This Sprint 🏃♀️
to Review 🔎
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
|
|
||
| Because of the hotfix version, any SQL scripts in "develop" should be renamed (from "5.11" to "5.11.1" for example). To read more about our naming conventions for SQL scripts, see :doc:`sql-upgrade-scripts`. | ||
|
|
||
| Please note that version bumps and SQL script renaming both require all open pull requests to be updated with the latest from the "develop" branch so you might want to add any SQL script renaming to the hotfix branch before you put it through QA to be merged with develop. This way, open pull requests only need to be updated once. |
There was a problem hiding this comment.
[possibly a dumb] Question - is this actually necessary, to go to the trouble of renaming flyway scripts on account of hotfix/emergency releases? In our current situation, we could have kept the existing V15.11.0.* scripts in the develop branch, and it wouldn't have broken anything, I don't think. Are there any situations where it would in fact be absolutely necessary?
There was a problem hiding this comment.
Renaming the SQL scripts is not strictly necessary but it keeps things tidy and consistent, which I think is worth it.
(That's why I wrote it this way and did the renaming.)
I say we try it. Try to be tidy and consistent. If it's really a pain point we can drop it some day.
There was a problem hiding this comment.
I can't imagine this ever becoming a real pain point. Hotfix releases are rare by nature.
And sure, "tidy and consistent" should be a good enough reason.
tiny cosmetic change to the version number in the example
|
At standup this morning we agree that it's fine to go ahead and merge this. I'm happy with it and @landreev took a look. We can always make another PR with further revisions later. |
What this PR does / why we need it:
We've never made a hotfix before. Let's document the plan and revise as needed. I also addressed #8795 and did some general cleanup including moving the part about release notes to the top since we always write release notes first.
Which issue(s) this PR closes:
Special notes for your reviewer:
You can preview the HTML at https://dataverse-guide--8877.org.readthedocs.build/en/8877/developers/making-releases.html
Suggestions on how to test this:
Just docs.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
No.
Additional documentation:
None.