logo_kerberos.gif

Release engineering notes

From K5Wiki
(Difference between revisions)
Jump to: navigation, search
Line 11: Line 11:
 
* manually update README
 
* manually update README
 
** dates
 
** dates
** changes
+
** changes -- always grab a fresh list from RT when editing these!
** contributors
+
** contributors (RT is a good source for these)
 
* make additional manpage and update-po commits with updated patchlevel.h
 
* make additional manpage and update-po commits with updated patchlevel.h
* squash preceding commits so all versioning-related commits are a single commit (non-versioning changes should remain separate commits)
+
* squash preceding commits so all versioning-related commits are a single commit (non-versioning changes to maintainer-mode stuff should remain separate commits)
 
* <code>git tag krb5-x.y.z-final</code>
 
* <code>git tag krb5-x.y.z-final</code>
   
Line 32: Line 32:
 
* generate branded HTML docs
 
* generate branded HTML docs
 
* edit web pages
 
* edit web pages
* send announcement
+
* send announcement to kerberos-announce

Revision as of 20:35, 19 July 2016

Contents

Required manual steps

Pre-mkrel

  • check copyright years in project-wide stuff
  • make sure you're in a build tree that's not the source tree and configured using --enable-maintainer-mode
  • make depend and commit if changed
  • regenerate manpages: (cd man && make man) and commit if changed
  • regenerate localization template (cd po && make update-po) and commit if changed
  • manually edit patchlevel.h to reflect the new release
  • manually update README
    • dates
    • changes -- always grab a fresh list from RT when editing these!
    • contributors (RT is a good source for these)
  • make additional manpage and update-po commits with updated patchlevel.h
  • squash preceding commits so all versioning-related commits are a single commit (non-versioning changes to maintainer-mode stuff should remain separate commits)
  • git tag krb5-x.y.z-final

Running mkrel

  • path_to_mkrel/mkrel --repository $YOUR_SOURCE_TREE krb5-x.y.z-final krb5-x.y.z
  • manually inspect output for versioning and correctness
    • HTML docs
    • PDF docs
    • patchlevel.h as modified by mkrel
  • push to authoritative repository
  • rerun mkrel against the authoritative repository: path_to_mkrel/mkrel krb5-x.y.z-final krb5-x.y.z

Post-mkrel

  • PGP sign
  • generate branded HTML docs
  • edit web pages
  • send announcement to kerberos-announce
Personal tools