Update release process docs #3555
Conversation
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
docs/developer/release-process.md
Outdated
|
|
||
| ```bash | ||
| # assuming you are in the main branch, with the latest changes pulled locally | ||
| git checkout -b prerelease |
There was a problem hiding this comment.
Looks like we're missing a step here to merge the main branch?
|
|
||
| ## 1.2 - Perform a manual test | ||
|
|
||
| Even though we have a thorough test suite in our repository, we still _must_ perform a manual review of the application as it is in the selected commit. To do so, follow these instructions: |
There was a problem hiding this comment.
Looking at the manual steps outlined, I'm unsure why we need to do this, given it's what we already check in CII. Or is it the installation in an additional cluster? So if we add a test for that, we can remove this manual check, or do you think it should always be done as a sanity check?
There was a problem hiding this comment.
Good point, it's true... but even if the core functionality is being tested, we cannot guarantee the UI interactions are gonna work in the tagged release. I mean, what if Clarity UI now changes a header color? or the dependency in charge of rendering the markdown has a bug we haven't noticed?
Given the monthly release cadence we have, I think we can afford this manual test. At least, I'm personally more relaxed knowing it is working when some tests start crashing for no (known) reaso, haha.
Signed-off-by: Antonio Gamez Diaz <agamez@vmware.com>
Description of the change
As I'm executing the release process, I'm updating with the new steps after including the prerelease flow.
Benefits
Up to date guide
Possible drawbacks
N/A
Applicable issues
Additional information
N/A