Differences between revisions 19 and 32 (spanning 13 versions)
Revision 19 as of 2019-02-08 02:29:58
Size: 2629
Comment: create tag after release is accepted
Revision 32 as of 2020-01-17 02:33:18
Size: 4037
Comment: add reminders to sign tags
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
This is a brief description of the process of releasing a new version of FreedomBox. This is a brief description of the process of releasing a new version of !FreedomBox.
Line 9: Line 9:
== Plinth Release == == Release ==
Line 12: Line 12:
 1. First, check if there are any [[https://hosted.weblate.org/projects/freedombox/plinth/#repository|uncommitted changes]] on weblate. Commit if there are any.  1. Check if there are any [[https://hosted.weblate.org/projects/freedombox/plinth/#repository|uncommitted changes]] on weblate. Commit if there are any.
 1. Clone the plinth repository, and check out latest master branch.
Line 14: Line 15:
 1. Update debian/changelog in the Plinth repository, including details that are relevant to contributors.
    * You can r
un {{{gbp dch -a --multimaint-merge}}}, then remove duplicates.
    * Also check [[https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=no&src=plinth|plinth bugs]] to see if any Debian bugs should be closed by the changes in the release.
 1. Update the [[FreedomBox/ReleaseNotes|Release Notes]] on the wiki. This is a summary of changes that are relevant to end users.
 1. Run {{{gbp dch -a --multimaint-merge}}} to update debian/changelog.
    * Check [[https://bugs.debian.org/cgi-bin/pkgreport.cgi?repeatmerged=no&src=plinth|plinth bugs]] to see if any Debian bugs should be closed by the changes in the release.
    * Remove any {{{(Closes: nnnn)}}} that refer to Salsa issues rather than Debian bugs
.
 1. Update the [[FreedomBox/ReleaseNotes|Release Notes]] on the wiki. This is a summary of changes that are relevant to end users or otherwise important to note.
Line 21: Line 22:
 1. Commit these changes with the message "Release <version> to unstable".  1. Commit these changes with the message "Release v<version> to unstable".
Line 24: Line 25:
    * Recommended to test by installing the package in a development environment, or by building a freedom-maker image with --custom-package.
    * You can also run autopkgtest:
      * {{{autopkgtest --apt-upgrade -B <new freedombox .deb> <source folder> -- lxc --sudo autopkgtest-unstable-amd64}}}
 1. Run autopkgtest:
    * {{{autopkgtest --apt-upgrade -B <new freedombox .deb> <source folder> -- qemu ~/autopkgtest/sid}}}
 1. Test the new package by installing the package in a development environment, or by building a freedom-maker image with --custom-package.
Line 31: Line 32:
 1. After the release is accepted into Unstable, create a tag for the release. Push commits and the new tag to the Salsa repository.  1. After the release is accepted into Unstable, create a (signed) tag for the release. Push commits and the new tag to the Salsa repository.
Line 36: Line 37:
 1. Publish changelog on various channels - mailing lists, irc and matrix groups, Twitter or GNU Social etc.  1. Publish changes from Release Notes on various channels:
    * [[https://discuss.freedombox.org/c/announcements|discussion forum]]
    * mailing lists
    * irc and matrix groups
    * Mastodon or Twitter, etc.
Line 38: Line 43:

== Backports ==

A release can be backported to stable-backports after it has migrated to testing.

 1. Check out the debian/buster-backports branch.
 1. Merge the latest release tag.
    * There will be a merge conflict due to debian/changelog. Resolve it by arranging the releases in the correct chronological order.
 1. Run {{{dch --bpo}}} to add the debian/changelog entry for the new backport release.
 1. Commit this change with message "Release <version> to buster-backports".
 1. Build the binary package with {{{DIST=buster gbp buildpackage -v<previous>}}} where <previous> is the previous version in backports.
 1. There is a [[https://app.vagrantup.com/freedombox/boxes/freedombox-buster-dev|vagrant box]] based on buster that can be used for testing.
    * Set it up using [[https://salsa.debian.org/freedombox-team/plinth/snippets/273|this Vagrantfile]].
 1. Run autopkgtest:
    * {{{autopkgtest --apt-upgrade -B <new freedombox .deb> <source folder> -- qemu ~/autopkgtest/buster}}}
 1. Sign the dsc and changes files with debsign.
 1. Upload the changes file with dput.
 1. After the release is accepted into backports, create a (signed) tag for the release. Push debian/buster-backports and the new tag to the Salsa repository.

This is a brief description of the process of releasing a new version of FreedomBox.

Pre release (work in progress)

  1. Check that unit tests are not broken.

  2. Run plinth functional tests against current master.

  3. Check if boot process happens on one image.

Release

Releases are currently done every 2 weeks.

  1. Check if there are any uncommitted changes on weblate. Commit if there are any.

  2. Clone the plinth repository, and check out latest master branch.
  3. Update translation strings by running python3 setup.py update_translations. Commit.

  4. Run gbp dch -a --multimaint-merge to update debian/changelog.

    • Check plinth bugs to see if any Debian bugs should be closed by the changes in the release.

    • Remove any (Closes: nnnn) that refer to Salsa issues rather than Debian bugs.

  5. Update the Release Notes on the wiki. This is a summary of changes that are relevant to end users or otherwise important to note.

  6. Fetch the latest manual by running make -C doc fetch. Commit.

  7. Update the version number in plinth/__init__.py.

  8. Run dch -r and finalize the changelog.

  9. Commit these changes with the message "Release v<version> to unstable".

  10. Build the package using gbp buildpackage.

    • Check for any new lintian errors.
  11. Run autopkgtest:
    • autopkgtest --apt-upgrade -B <new freedombox .deb> <source folder> -- qemu ~/autopkgtest/sid

  12. Test the new package by installing the package in a development environment, or by building a freedom-maker image with --custom-package.
  13. Build the source-only package using gbp buildpackage --changes-option=-S.

  14. Sign the dsc and changes files with debsign.
  15. Upload the changes file with dput.
  16. When the release is accepted into Unstable, you will get an email "Accepted plinth x.y.z (source) into unstable".
  17. After the release is accepted into Unstable, create a (signed) tag for the release. Push commits and the new tag to the Salsa repository.
    • Weblate will automatically update with the latest changes.

Post release (work in progress)

  1. Publish changes from Release Notes on various channels:
  2. Upload new image to Vagrant Cloud.

Backports

A release can be backported to stable-backports after it has migrated to testing.

  1. Check out the debian/buster-backports branch.
  2. Merge the latest release tag.
    • There will be a merge conflict due to debian/changelog. Resolve it by arranging the releases in the correct chronological order.
  3. Run dch --bpo to add the debian/changelog entry for the new backport release.

  4. Commit this change with message "Release <version> to buster-backports".

  5. Build the binary package with DIST=buster gbp buildpackage -v<previous> where <previous> is the previous version in backports.

  6. There is a vagrant box based on buster that can be used for testing.

  7. Run autopkgtest:
    • autopkgtest --apt-upgrade -B <new freedombox .deb> <source folder> -- qemu ~/autopkgtest/buster

  8. Sign the dsc and changes files with debsign.
  9. Upload the changes file with dput.
  10. After the release is accepted into backports, create a (signed) tag for the release. Push debian/buster-backports and the new tag to the Salsa repository.


CategoryFreedomBox