Loading...
 

Continuous upstream

Page name could change when concept becomes clearer :-)

Context

  • As per Where to commit, new features generally shouldn't be committed to the stable branch. They belong in trunk.
    • You are running a Tiki, which is somewhat critical and/or has a lot of features and it takes quite a bit of time to test everything. You don't want down time and you need features to be stable. So you want to run a stable branch of Tiki (not trunk).
    • You are working on new features, which you want to contribute to trunk
    • You would like some of these new features as soon as possible available to your site and not wait up to 6 months for trunk to become the next stable version of Tiki.
    • You also have some non-upstreamable stuff (a theme and perhaps some things that are very specific to this project and not interesting for the community at large)
  • You want to avoid custom code as much as possible and want each major upgrade to be as smooth as possible because all code/features has been upstreamed to trunk (Commit early, Commit often)

Examples

  • Running a SaaS service, where releases of new features can be done every few weeks.

Workflow trunk to stable

Code in trunk and cherry-pick backports

Pros
  • This is how the workflow should be.
  • New code takes advantage of new trunk features
  • Helping to keep trunk stable

Cons
  • Trunk bugs (which are to be expected) can slow you down
  • Sometimes, backport is messy because it involves something else only in trunk

Instances

  • example.org: live site
    • stable branch
      • + own code already committed to trunk and backported locally
      • + own code that is not destined to be upstreamed (ex.: theme)
    • updated regularly to tip of stable branch
  • staging.example.org
    • Generally same code and data as live site, but with a few recent changes that need to tested
  • next.example.org: take production site and pre-dogfood server script (for code, not just data like current script does).


Important wish: TRIM make clone (mirror) and make cloneandupdate or cloneandupgrade (pre-dogfood server)

Steps

We will need to write scripts to automate this more, but here are steps for now.

  1. Make sure your system requirements are sufficient to run trunk -> Server Check
  2. Update your production code to the tip of the stable branch
    • Check if the update would cause conflicts
    • Check that nothing obvious is broken in the files that have been changed
    • You now have the tip of stable branch, along with your locally managed modifications on your site
  3. Run pre-dogfood server script to get latest trunk and latest data on next
  4. Run script to make staging server be identical to production
  5. Test the feature you are about to code on
  6. Work on next. Make your feature.
  7. Once you are pleased with it, merge all modified files to the staging server
  8. Test. If all is good commit to trunk (in one commit, it makes it easier), and backport this commit to your stable site, along with any content / configuration changes
    • Your prod and staging should be identical at this point. A script to double-check this would be useful.

Workflow stable to trunk

Code on stable branch and merge to trunk

Pros
  • Development on a more stable environment: fewer trunk bugs (which are to be expected) that can slow you down

Cons
  • Not taking advantage of new trunk features
  • Not helping much to keep trunk stable

Instances

  • Similar to above

Steps

  1. Make sure staging and next are up to date, in code and data
  2. Code on staging
  3. Test
  4. Merge changes to next
  5. Test
  6. Commit to Tiki trunk
  7. Backport this commit to live site
  8. Run again scripts to update staging and next


Page last modified on Tuesday 01 August, 2017 07:55:38 GMT-0000

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools