docs: add interactive release mode documentation

[cryptodev-2s]

Explanation

This PR updates our release process documentation to include the new interactive mode feature, making it easier for contributors to understand their options when creating releases.

Documentation Changes

• Added a new section explaining the interactive release mode
• Restructured the release process documentation to clearly show two paths:
  • Option A: Interactive Mode
  • Option B: Manual Release Specification
• Added detailed explanation of validation features including:
  • Dependency relationship checks
  • Peer dependency update requirements
  • Semantic versioning validation
• Included examples to help users understand when packages need to be included
• Added clear navigation between the two methods

References

Fixes #5440

Changelog

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate
• I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

[mcmire]

It looks like we are approaching this section by describing the features of this workflow rather than listing a series of steps that people can follow. I know that this workflow will be new to people for a while, but the way this reads currently I worry that people will skip over it.

In addition it seems that we are assuming that people will the section on manually releasing before reading this section on the UI, since we are linking from here to there (effectively jumping backward in the document). I wonder if this is the right way to arrange this section.

In a sense everything described for the manual flow also applies to the UI flow. People will still need to spend a moment to review changes, decide which versions to bump, etc. So maybe we ought to copy the steps listed there to here and then tweak them to fit the UI? Or we can extract step 3 and 4 above to another section.

I'm visualizing the two workflows like this:

flowchart TD
  stepA1[Run 'yarn create-release-branch'];
  stepA2[Modify release spec to specify packages to release];
  stepA3[Close your editor];
  stepA4[Handle errors, reopen the release spec, add more packages as necessary];
  stepB1[Run 'yarn create-release-branch -i'];
  stepB2[Specify packages to release in the UI];
  stepB3[Handle errors and add more packages as necessary via the UI];
  step4[Review and update changelogs];
  step5[Push the branch, create a PR];
  step6[Update the branch with new changes as necessary];

  stepA1 --> stepA2;
  stepA2 --> stepA3;
  stepA3 --> stepA4;
  stepA4 --> step4;
  stepB1 --> stepB2;
  stepB2 --> stepB3;
  stepB3 --> step4;
  step4 --> step5;
  step5 --> step6;

Loading

So perhaps we want to have the steps reflect this?

[mcmire]

Sorry one more thing, otherwise we're good to go.

[mcmire]

Looks great! Thank you for doing this.