diff options
author | Quentin Young <qlyoung@users.noreply.github.com> | 2018-07-10 21:39:49 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-07-10 21:39:49 +0200 |
commit | 11acdeacaff9bfd0944eafa07c0e1f3c03d89834 (patch) | |
tree | 7d84c71e76f77c33387a4137f972d0f87492c431 /doc | |
parent | Merge pull request #2643 from qlyoung/doc-workflow-reviews (diff) | |
parent | doc: Add document for Release Build by maintainer (diff) | |
download | frr-11acdeacaff9bfd0944eafa07c0e1f3c03d89834.tar.xz frr-11acdeacaff9bfd0944eafa07c0e1f3c03d89834.zip |
Merge pull request #2553 from opensourcerouting/release_proc
doc: Add document for Release Build by maintainer
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 1 | ||||
-rw-r--r-- | doc/developer/maintainer-release-build.rst | 86 |
2 files changed, 87 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 1f27e4a8e..62cb3c2ed 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -183,6 +183,7 @@ EXTRA_DIST = frr-sphinx.mk \ developer/ldpd-basic-test-setup.md \ developer/library.rst \ developer/Makefile.in \ + developer/maintainer-release-build.rst \ developer/memtypes.rst \ developer/modules.rst \ developer/next-hop-tracking.rst \ diff --git a/doc/developer/maintainer-release-build.rst b/doc/developer/maintainer-release-build.rst new file mode 100644 index 000000000..d2dbcc76b --- /dev/null +++ b/doc/developer/maintainer-release-build.rst @@ -0,0 +1,86 @@ +Release Build Procedure for FRR maintainers +========================================================= + +1) Rename branch (if needed) + +.. code-block:: shell + + git clone git@github.com:FRRouting/frr.git + cd frr + git checkout dev/5.0 + git push origin :refs/heads/dev/5.0 + git push origin dev/5.0:refs/heads/stable/5.0 + +2) Checkout the new stable branch: + +.. code-block:: shell + + git checkout stable/5.0 + +3) Update Changelog for RedHat Package: + + Edit :file:`redhat/frr.spec.in` and look for %changelog section: + + - Change last (top of list) entry from %{version} to previous + fixed version number, ie + + ``* Tue Nov 7 2017 Martin Winter <mwinter@opensourcerouting.org> - %{version}`` + + to + + ``* Tue Nov 7 2017 Martin Winter <mwinter@opensourcerouting.org> - 3.0.2`` + + - Add new entry (top of list) with ``%{version}`` tag and changelog + for version. + Make sure to watch for format, ie day is always 2 chars, with 1st + char a space if single digit + +4) Update Changelog for Debian Packages: + + Edit :file:`debianpkg/changelog.in`: + + - Change last (top of list) entry from @VERSION@ to previous + fixed version number, ie + + ``frr (@VERSION@) RELEASED; urgency=medium`` + + to + + ``frr (3.0.2) RELEASED; urgency=medium`` + + - Add new entry (top of list) with @VERSION@ tag and changelog for version + +5) Change main version number: + + - Edit :file:`configure.ac` and change version in ``AC_INIT`` command + - Create new entry with version as ``%{version}`` tag + +6) Test building at least a Redhat and a Ubuntu Package (or create a PR + to have the CI system test them) + +7) Commit the changes (add changelog to commit message) + +8) Create Tag for Version: + +.. code-block:: shell + + git tag -a frr-5.0 -m "FRRouting Release 5.0" + +9) Push commit and Tags and watch for errors on CI + +.. code-block:: shell + + git push + git push --tags + +10) Kick off the Release build plan on the CI system for the correct release + +11) Send Release Announcement with changes to ``announce@lists.frrouting.org`` + +12) Kick off the Snapcraft build plan for the correct release + +13) After CI plans succeed, release on github. + + Go to https://github.com/FRRouting/frr/releases and select "Draft a new release" + +14) Deploy Snapcraft Release (after CI system finishes the tests for snapcraft testplan) |