Skip to main content

Release Notes Process

  1. Collect changes to callout for the release:
    1. Main places to check for big feature callouts are:
      1. Pre-Sprint Planning page for the given release number.
      2. Feature showcase deck
    2. For the full enhancements and bug fixes section of the change log, I run a query in ADO where the Release Target or the UX Release Target = current release number.
      1. I export this list to Excel and add a column to identify the ones that are customer impacting (will affect them in some way, i.e. I exclude any internal changes or things that are feature flagged/still WIP). This identification is largely done by just having context and understanding the different features and work in progress, but for the ones I'm unsure of, I first read the ticket description and if still in doubt, I leave a comment for the assignee asking for more information.
      2. I filter down the list to the changes that are customer impacting
      3. I use CoPilot to feed in the story titles and ask it to format and name it similarly to a previous change log bug/enhancement list.
  2. Draft the content:
    1. Change log:
      1. Add a new page to the change log section in ReadMe with the page set to Hidden.
      2. Email:
        1. Marketing now sends this email out for us, so we need to draft it in a Word document (example) and then make a submission to their request form for them to send it. It can take up to a week for them to answer our request, so we need to keep that in mind for timing.
    2. Docs Roadmap:
      1. Hit "Suggest Edits" on the Product Release Roadmap page in ReadMe.
      2. Edit the 'Custom HTML' block for the relevant changes.
      3. Hit "Suggest" at the top.
      4. Put the release version number in the title. Add a note in the description to not merge until that version number release.
    3. Docs changes:
      1. If any updates require changes to our ReadMe docs:
        1. Hit "Suggest Edits" on the given page in ReadMe.
        2. Edit the content needed.
        3. Hit "Suggest" at the top.
        4. Put the release version number in the title. Add a note in the description to not merge until that version number release.
  3. Review
    1. Once drafted, I verify my features/enhancements/bug list is comprehensive with the engineering leads, then I run all of the content above by the product team chat.
  4. Release the changes:
    1. Once delivery/QA/product have agreed that we are ready to release and send out the release email:
      1. Go to the Suggested Edits admin page in ReadMe - merge in anything tagged with the current version number.
      2. In the Admin dashboard, from the nav menu, click on the version number drop down, hit manage versions, then Add New Version. Mark the new version number as main. Update the previous version to not be public and mark as deprecated.
      3. See 2.b.ii above.