Getting Started

Jira Tickets

youYou will getbe assigned 4four tickets:Jiras. Below are the Jiras and in the suggested order to work them:

1. createCreate shella "shell" file for RNthe release notes
2. createCreate dummya RN"placeholder" file for the release notes
3. reviewReview the known issues and bug fixes
4. updateUpdate and assemble cnvthe CNV release notes

RNRelease Note Shell File

A "shell" file will need to be created so that writers can start adding release notes. The process is essentially copying over the previous version's release note file and preparing it for the new version by:

• UpdateUpdating the release notes file name and anchor IDs
• RemoveRemoving notesall content under New and changed features but making sure to leave headers
• RemoveRemoving Bug fixes content
• RemoveRemoving Removed features content

forThis is a step by step process with commands included. Be sure to replace 4.16 and 4.17 with the sakeversions ofyou clarity,are theworking guide below is based off of going from 4.16 to 4.17with.

1. checkoutCheck out the branch forof the new releaseversion: you're
   working
   • on$ git checkout enterprise-4.17 ; git fetch upstream
2. createCreate a feature branch (off of the enteprise branch:
   • $ git checkout -b CNV-34645-4-16-RN-shell)XXXX
3. renameRename filethe old version filename to the new version andfilename: replace
   old
   • version$ strings with new ones

git mv virt/release_notes/virt-4-16-release-notes.adoc virt/release_notes/virt-4-17-release-notes.adoc



Replace all old version strings with the new version strings in the release notes file:


$ sed -i 's/virt-4-16/virt-4-17/g' virt/release_notes/virt-4-17-release-notes.adoc



Replace old version string with the new version string in the _topic_map.yml file:


$ sed -i 's/virt-4-16-release-notes/virt-4-17-release-notes/g' _topic_maps/_topic_map.yml

4. Remove theall oldcontent under New and changed features, Bug fixes, and Removed features in the release-note file while making sure to leave the headers of the sections.
5. Save all changes and submit your pull request.

Example PR: Link

Release Note Placeholder File

For builds and tests to be successful in your GitHub pull request, you must open a separate PR to add a dummy release notes (keepfile to the componentmain subheadings,branch. suchThis asis Installation,a Storage,step etc.).by step process with commands included. Be sure to replace 4.17 with the version you are working on.

1. Check out the branch of the new version:
   • $ git checkout main ; git fetch upstream
2. Create a feature branch off of the main branch:
   • $ git checkout -b CNV-XXXX
3. Create a new placeholder file with the new version name:
   • $ touch virt/release_notes/virt-4-17-release-notes.adoc
4. Place the contents below into that file and save it.

   :_content-type: ASSEMBLY
   [id="virt-4-17-release-notes"]
   = {VirtProductName} release notes
   include::_attributes/common-attributes.adoc[]
   :context: virt-4-17-release-notes
   toc::[]
   
   Do not removeadd anythingor edit release notes here. Edit release notes directly in the Knownbranch
   issuesthat sectionthey yetare relevant for.
   
   This file is here to allow builds to work.
   

5. Save all changes and submit your pull request.