Correct how to test for additional properties in RSpec guidance for internal event testing
What does this MR do and why?
We've discovered in !163352 (merged) that the guidance around how to use additional properties within our shared example for internal events is not mentioned in our documentation and additionally the guidance in the CLI is confusing. We aim to further clarify this in #480381.
In the meantime, this MR adds a minimal documentation to the docs and changes the CLI to showcase the more understandable approach of adding additional properties within a separate object.
MR acceptance checklist
Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Screenshots or screen recordings
How to set up and validate locally
- Run
ruby scripts/internal_events/cli.rb - Select
3. View Usage.. - Select an event that has additional properties, e.g.
unprotect_branch
Numbered steps to set up and validate the change are strongly suggested.