FRR Release Procedure

<version> - version to be released, e.g. 7.3 origin - FRR upstream repository

Stage 1 - Preparation

  1. Checkout the existing dev/<version> branch.

    git checkout dev/<version>
    
  2. Create and push a new branch called stable/<version> based on the dev/<version> branch.

    git checkout -b stable/<version>
    
  3. Remove the development branch called dev/<version>

    git push origin --delete dev/<version>
    
  4. Update Changelog for Red Hat Packages:

    Edit redhat/frr.spec.in and look for the %changelog section:

    • Change last (top of list) entry from %{version} to the last released version number. For example, if <version> is 7.3 and the last public release was 7.2, you would use 7.2, changing the file like so:

      * Tue Nov  7 2017 Martin Winter <mwinter@opensourcerouting.org> - %{version}
      

      to:

      * Tue Nov  7 2017 Martin Winter <mwinter@opensourcerouting.org> - 7.2
      
    • Add new entry to the top of the list with %{version} tag. Make sure to watch the format, i.e. the day is always 2 characters, with the 1st character being a space if the day is one digit.

    • Add the changelog text below this entry.

  5. Update Changelog for Debian Packages:

    Update debian/changelog:

    • Run following with last release version number and debian revision (usually -1) as argument to dch --newversion VERSION. For example, if <version> is 7.3 then you will run dch --newversion 7.3-1.

    • The dch will run an editor, and you should add the changelog text below this entry, usually that would be: New upstream version.

    • Verify the changelog format using dpkg-parsechangelog. In the repository root:

      dpkg-parsechangelog
      

      You should see output like this:

      vagrant@local ~/frr> dpkg-parsechangelog
      Source: frr
      Version: 7.3-dev-0
      Distribution: UNRELEASED
      Urgency: medium
      Maintainer: FRRouting-Dev <dev@lists.frrouting.org>
      Timestamp: 1540478210
      Date: Thu, 25 Oct 2018 16:36:50 +0200
      Changes:
       frr (7.3-dev-0) RELEASED; urgency=medium
       .
         * Your Changes Here
      
  6. Commit the changes, adding the changelog to the commit message. Follow all existing commit guidelines. The commit message should be akin to:

    debian, redhat: updating changelog for new release
    
  7. Change main version number:

    • Edit configure.ac and change version in the AC_INIT command to <version>

    Add and commit this change. This commit should be separate from the commit containing the changelog. The commit message should be:

    FRR Release <version>
    

    The version field should be complete; i.e. for 8.0.0, the version should be 8.0.0 and not 8.0 or 8.

Stage 2 - Staging

  1. Push the stable branch to a new remote branch prefixed with rc:

    git push origin stable/<version>:rc/version
    

    This will trigger the NetDEF CI, which serve as a sanity check on the release branch. Verify that all tests pass and that all package builds are successful. To do this, go to the NetDEF CI located here:

    https://ci1.netdef.org/browse/FRR-FRR

    In the top left, look for rc-<version> in the “Plan branch” dropdown. Select this version. Note that it may take a few minutes for the CI to kick in on this new branch and appear in the list.

  2. Push the stable branch:

    git push origin stable/<version>:refs/heads/stable/<version>
    
  3. Create and push a git tag for the version:

    git tag -a frr-<version> -m "FRRouting Release <version>"
    git push origin frr-<version>
    
  4. Create a new branch based on master, cherry-pick the commit made earlier that added the changelogs, and use it to create a PR against master. This way master has the latest changelog for the next cycle.

  5. Kick off the “Release” build plan on the CI system for the correct release. Contact Martin Winter for this step. Ensure all release packages build successfully.

  6. Kick off the Snapcraft build plan for the release.

Stage 3 - Publish

  1. Upload both the Debian and RPM packages to their respective repositories.

  2. Coordinate with the maintainer of FRR’s RPM repository to publish the RPM packages on that repository. Update the repository webpage. Verify that the instructions on the webpage work and that FRR is installable from the repository on a Red Hat system.

    Current maintainer: Martin Winter

  3. Coordinate with the maintainer of FRR Debian package to publish the Debian packages on that repository. Update the repository webpage. Verify that the instructions on the webpage work and that FRR is installable from the repository on a Debian system.

    Current maintainer: Jafar Al-Gharaibeh

  4. Log in to the Read The Docs instance. in the “FRRouting” project, navigate to the “Overview” tab. Ensure there is a stable-<version> version listed and that it is enabled. Go to “Admin” and then “Advanced Settings”. Change “Default version” to the new version. This ensures that the documentation shown to visitors is that of the latest release by default.

    This step must be performed by someone with administrative access to the Read the Docs instance.

  5. On GitHub, go to the <https://github.com/FRRouting/frr/releases>_ and click “Draft a new release”. Write a release announcement. The release announcement should follow the template in release-announcement-template.md, located next to this document. Check for spelling errors, and optionally (but preferably) have other maintainers proofread the announcement text.

    Do not attach any packages or source tarballs to the GitHub release.

    Publish the release once it is reviewed.

  6. Deploy Snapcraft release. Remember that this will automatically upgrade Snap users.

    Current maintainer: Martin Winter

  7. Build and publish the Docker containers.

    Current maintainer: Quentin Young

  8. Clone the frr-www repository:

    git clone https://github.com/FRRouting/frr-www.git
    
  9. Add a new release announcement, using a previous announcement as template:

    cp <old-version>.md <version>.md
    

    Paste the GitHub release announcement text into this document, and remove line breaks. In other words, this:

    This is one continuous
    sentence that should be
    rendered on one line
    

    Needs to be changed to this:

    This is one continuous sentence that should be rendered on one line
    

    This is very important otherwise the announcement will be unreadable on the website.

    Make sure to add a link to the GitHub releases page at the top.

    Once finished, manually add a new entry into index.html to link to this new announcement. Look at past commits to see how to do this.

  10. Deploy the updated frr-www on the frrouting.org web server and verify that the announcement text is visible.

  11. Send an email to announce@lists.frrouting.org. The text of this email should include text as appropriate from the GitHub release and a link to the GitHub release, Debian repository, and RPM repository.