Production Release Checklist

Steps when preparing a new production release

Release preparation

• Create, Test and Upload a release package - BuildingARelease
  • Attach the new .zip, .tgz, and .md5 to Codev.Release
• Create, Test and Upload the TWiki-VM package - DownloadTWikiVM
  • Updated .md5 with TWiki-VM package
  • Attach TWiki-VM-x.x.x-x.zip, .md5 to Codev.Release
• Upload the new .zip, .tgz, and .md5 to SourceForge (see file management instructions). Make sure .zip or .tgz are by default the first package file available to download when users visit to TWiki package area on http://sf.net site.
  • Secure copy: scp file.zip USER@frs.sourceforge.net:/home/frs/project/twiki (can't copy to subdir with spaces)
  • Shell:
    • ssh -t USER,twiki@shell.sourceforge.net create
    • cd /home/frs/project/twiki
    • mkdir TWiki\ for\ all\ Platforms/TWiki-6.1.0
    • Move files to TWiki\ for\ all\ Platforms/TWiki-6.1.0
    • Create README.txt in that directory, content:
      See TWiki-6.1.0 Release Notes at http://twiki.org/cgi-bin/view/TWiki/TWikiReleaseNotes06x01
  • Visit https://sourceforge.net/projects/twiki/files/, go to new folder, click on the {i) icon of .tgz and .zip, and set the desired platform (.zip for Win and Mac, all other .tgz) - this sets the default download for latest release
• Update TWikiAdvocacy topics:
  • Create new TWikiAdvocacy06x01 topic
  • Create press release
  • Compile advocacy target list
  • Review/update TWikiAdvocacyForPublicSites

Release documentation and linking updates

• Update TWikiProductionRelease topic
• Create new release topic, such as TWikiRelease06x01x00
• Create new release discussion topic, such as TWikiRelease06x01x00Comments
• In Main.TWikiPreferences, update LATEST_TWIKI_RELEASE_* settings (to tell DownloadTWiki to include the correct topic)
• Change the previous release topic to the format of the one before that, e.g. add the "outdated release" note on top
• Touch (edit/save) DownloadTWiki - some people watch this page for updates
• Update DownloadTWikiVM with latest release (once VM is built)
• Login with ssh:
  • Update index.html with new version number
• Update Codev web:
  • Update/create known issues topic - KnownIssuesOfTWiki06x01
  • Add new release to ProposedFor field in ChangeProposalForm
• Create/update new TWiki documentation web:
  • For major/minor releases, create a TWiki06x01 web with content of the TWiki web of the release package.
  • Edit TWiki06x01.WebPreferences, add a BROADCAST message and tweak the SITEMAPWHAT setting.
  • Edit TWiki06x01.TWikiRegistration, disable registration form, and add note that disabled.
• Update TWiki web:
  • Update TWiki web topics TWiki.TWikiHistory, TWiki.TWikiUpgradeGuide, TWiki.TWikiInstallationGuide, TWiki.TWikiReleaseNotes06x01, TWiki.TWikiDocGraphics (same in TWiki06x01 web for patch release)
  • Update TWiki.ReleaseDocumentation with latest release info
  • Update supplemental doc TWiki.InstallingTWiki with links to latest release
  • Create new TWikiUpgradeTo06x01 topic, starting from UpgradingTWiki
• Update Plugins web:
  • Update Plugins.TestedOnTWiki
  • Starting in Plugins.ExtensionsTestedOnTWiki create Plugins.PluginsTestedOnTWiki06x01 and Plugins.ExtensionsTestedOnTWiki06x01
  • Update all PluginPackages, AddOnPackages, SkinPackages and ContribPackages with latest TestedOnTWiki info - use GlobalReplacePlugin for mass update
• Update Support web:
  • Add new release to selector in Support.SupportForm
• Update TWikibug:WebHome database:
  • Update TWikibug:ItemTemplate 's Codebase and ReleasedIn form fields with new version number
  • Close old TWiki doc bug item, and create a new one
  • Close old TWiki extension doc bug item, and create a new one
  • Close old TWiki translation bug item, and create a new one
  • Close old TWikiDocGraphics bug item, and create a new one
  • In TWikibug:WebPreferences, update BROADCASTMESSAGE with new doc bug item number
  • Update TWikibug:WebTopMenu with latest code name
• Add InterwikiPlugin link rule for new branch:
  • Edit TWiki.InterSiteLinkRules and add a SVN06x01 rule in the "TWiki Specific Links" section

Post release

• Decide CodeName of follow up release and create topic (AthensRelease, BeijingRelease...)
• Announce in DevelopersNews
• Announce to TWikiDevMailingList
• Announce to TWikiAnnounceMailingList
• Blog about new release at TWiki.org Blog
• Tweet as @twiki and other users
• Announce on Facebook
• Announce on LinkedIn
• Announce to WikiMatrix, SF, Freecode and other web sites
• In #twiki IRC:
  • Update ChanServ welcome message for #twiki with new version number and download URL, such as:
    /msg chanserv set #twiki entrymsg Questions? Simply ask here or post a question in http://twiki.org/cgi-bin/view/Support -- Latest TWiki-6.1.0 released 2026-01-30, r22113
  • Update topic message, such as:
    /topic Questions? Simply ask here or post a question in http://twiki.org/cgi-bin/view/Support -- Latest TWiki-6.1.0 released 2026-01-30, r22113
  • Teach twikibot the new release, such as:
    twikibot: TWikiRelease06x01x00 is r18054 of TWiki, released 2026-01-30
twikibot: TWiki-6.1.0 is r22113 of TWiki, released 2026-01-30
• Announce at other places listed in TWikiAdvocacy06x01
• Toggle TWikibug:ReleasableItems that are relevant for current release from "Waiting for release" to "Closed". Hint:
  • Tweak the TWikibug:PatternSkinItemViewTemplate to temporarily add a "Quick Close" button to the "Item Form Data" tab (commented out)
  • In TWikibug:ReleaseNotes run the "patch" report for patch releases, else "any" report
  • Open each item in a new browser tab, and click on the "Quick Close" button
  • Comment out the "Quick Close" button in TWikibug:PatternSkinItemViewTemplate

-- Contributors: PeterThoeny, SvenDowideit, KennethLavrsen

Comments