VPP/CommitterTasks/CutRelease
Contents
Instructions for vpp release manager
It is strongly recommended you do the prerequisites the week prior to the FR Milestone and start the release process a day or two prior to release.
Prerequisites
1. Update Wiki - Edit the following wiki pages and add/revise references for new release
2. Review docs.fd.io
- a. On the release throttle branch (e.g. stable/1801), add release specific links to .../vpp/doxygen/test_framework_doc.md
- b. From workspace root, build doxygen output
make bootstrap-doxygen doxygen
- c. Check documentation output by opening the document index file in a browser:
- file:///<path to workspace root>/build-root/docs/html/index.html
- d. Clean up any formatting issues found.
- e. Submit patch.
- f. After patch is merged, cherry-pick it to master.
3. Update .../vpp/extras/scripts/list_api_changes.py with current release rc0 tag (if necessary)
4. Update release notes
- a. Edit .../vpp/RELEASE.md and add section for the current release
- b. Add number of commits by running the following command on the throttle branch (e.g. 18.01 <release rc0 tag> == v18.01-rc0)
git rev-list <release rc0 tag>..HEAD | wc -l
- c. Add Features section from the Release Plan & git log (Hint: gitk is your friend, jira not so much)
- d. Add list of API changes generated using VPP
- e. Add list of patches that changed api files by running the updated list_api_changes.py script
5. Submit release notes patch (e.g. "18.01 Release Notes")
6. Send email to vpp-dev@lists.fd.io asking for feedback on the release notes patch.
7. Merge release notes patch (which should be the patch where the release label is created).
8. Verify that all merge jobs (including docs) have completed successfully.
9. Cherry-pick release notes patch to master.
Recipe to Generate the Release
WARNING: If you push the release tag before the merge jobs have completed from the release note patch, then the merge jobs will fail when you do the "remerge" step below because nexus does not allow overwriting artifacts that already exist. If this does happen, then you need to open a helpdesk ticket helpdesk@fd.io asking for all of the nexus release artifacts to be purged. You may also have to get Ed Warnicke to clean out the release artifacts on packagecloud.io. You can also encounter this issue if the "remerge" jobs fail (keep your fingers crossed ;)
1. Send an email reminder to the VPP Committers to NOT MERGE ANY PATCHES onto the stable branch until after the completion of the release has been announced on vpp-dev@lists.fd.io.
2. Lay tag for “v18.01” on patch that is “last patch in series" (see Pushing and Testing a Tag but note NO -rc<#> suffix!!!)
3. “remerge” patch on that commit - so it creates various artifacts.
- Do remerge as per this picture
4. Once remerge jobs have successfully completed open case with LF staff to move artifacts to release repo
- Email helpdesk@fd.io using the email template below, substituting ${release number} with the release number (like 18.01) and ${release number without '.'} with the release number without '.' (like 1801).
5. Wait for LF infra staff to indicate they have completed the case
6. Test install behaviour on currently supported platforms (ie Centos7.2, Ubuntu Xenial) - use instructions for here to install 'release' packages and make sure you get a runnable version for ${release number} using release artifacts
- a. Install binary packages and verify VPP starts on supported VMs without any prior VPP installed
- b. Repeat above but upgrading from prior release of VPP to new release
7. Release the version in Jira
VPP committers should have admin access to Jira. From https://jira.fd.io/plugins/servlet/project-config/VPP/summary navigate to Releases (Or Versions, same thing) and under Actions for the release, select Release.
Tell Jira to move all still-open issues into the next release and set the release date appropriately.
8. Declare Victory!
helpdesk email template
Subject: Please publish VPP ${release number} Release Artifacts
Dear Helpdesk@fd.io,
The VPP artifacts for release ${release number} are now available on packagecloud.io and nexus.fd.io and are ready to be copied into the release directories.
Please let me know when they have been published so I can test the VPP ${release number} installations from nexus.
Thanks,
<Your Friendly VPP Release Manager>
Post Release Tasks
1. Watch the release branch for the first post release patch. A new <RELEASE>.1-rc0 tag is required to ensure that the latest build artifacts get downloaded from packagecloud.io when Installing VPP binaries from packages
2. Lay the tag for “v18.01.1-rc0” on first patch after the release (see Pushing and Testing a Tag). If there has been more than one patch merged onto the release branch, then add the git id of the first patch after release to the end of the "git tag" command when creating the tag.
3. Remerge the patch at HEAD of the release branch to generate the correct artifacts in the packagecloud.io repository.
