Loading...
 

How to Use the Release Server

2018-09-29: release.tiki.org will be rebuilt, hopefully in time to be used for the release of Tiki19 (plan B is that developers run on their own computers)

Note, these instructions should be updated to use the local copy of the sourceforge svn repository on the release server

Login

In this example we're releasing 12.6 pre. In your case, make sure to replace both 12.6 with the appropriate version. If you've gone through this process for the pre-release, and you ran into no issues, you need to remove "pre" from the various steps.

To begin the process, login by using your private/public key pair. If you haven't already done so, make sure to give a sysadmin your key so that they can provide you access. The release server is located at release.tiki.org.

Once your key is installed you need to log in with:

See password tool to see port number
ssh release@release.tiki.org

or if the key you got added is not your normal one (longer, or different algorythm, or whatever else; id_rsa4096_tiki in the following example), you might need to login with a slightly modified command after other 2 commands:

ssh-add ~/.ssh/id_rsa4096_tiki
export SSH_AUTH_SOCK=0
ssh -i ~/.ssh/id_rsa4096_tiki release@release.tiki.org

Checkout

Once logged in, do the following:

cd /home/release/WorkSpace/
svn checkout https://svn.code.sf.net/p/tikiwiki/code/branches/12.x
(Or set to the appropriate branch version)

Run Script

Next run the following script:

php doc/devtools/release.php 12.6 pre
(or appropriate branch version, "pre" specifies that it's a pre-release.)
  • When prompted to update working copy, type 'y' to update and hit enter.
  • When prompted to update README file, type 'y' to update.
  • When prompted to commit file, login to the server using an other terminal window. Once logged in, navigate appropriate directory:
cd  /home/release/WorkSpace/12.x
svn diff

to see the change in the README file. The change should show a line in the text that shows version incrementation.

  • Return to the original terminal window.
  • Type 'y' to commit.
  • When prompted to store password type 'no' so that you don't store your password on the server.
  • Next you will be ask if you want to update the language files, type 'y'.
  • Return to your secondary terminal and inspect the changes to ensure nothing is out of the ordinary.
svn commit
  • Update the changelog.txt, type 'y'
  • Commit new changelog.txt?

return to the secondary terminal and

svn diff

and ensure that everything is in order.

  • Commit new changelog.txt, 'y'
  • Update 'copyright.txt', for a minor release update the copyright 'Y'. If you have sufficient time, update the copyright. On a minor release this step can take approximately 5 minutes, on major release this can take much longer. If you don't have enough time, you can choose 'q' and re-run the script at a later time.
  • return to the secondary terminal 'svn diff', to verify, check if total users has increased. If all is right, svn commit.
  • When asked to check the syntax of the php files, type 'y'. The progress will appear. When releasing much older versions of Tiki that support legacy versions of PHP, (An older version of what is currently on the server) you may get a warning explaining that certain functions are deprecated or no longer available. In such an event, it's necessary to restart the script, and skip this step. This is unfortunately the only way around this issue. If it is a recent/current version of tiki, if any errors appear, this needs to be investigated.
  • When prompted to very the template syntax, type 'y'.
  • When prompted to Generate SecDB file.
  • Remove SecDB file 3.3.1
  • type 'y' to commit.
  • Build Package files (based on the branch)?, type 'y'
  • Once the packages have be built, composer will run, and several composer packages will installed. Ensure that there are no errors.
  • When the process is complete, several tarballs will have been created in ~/tikipack.
  • Ensure that at least you and one other person test the packages before placing them on release.tiki.org
cd ~/tikipack/
cp -r 12.6.pre /var/local/release.tiki.org/www/download

Once the file has been copied, it should be available on the web at release.tikit.org/download.

Testing

At this stage, get other people to test your release. The testing process should include:

  • Testing the profiles
  • One tester should test an upgrade
  • The other tester should test a fresh install


The preview tarballs will be available at https://release.tiki.org/download (use release as the username and password)

Repeat

Once you and another person have completed testing, and there are no issues repeat a similar process without including "pre".

cd /home/release/WorkSpace/12.x
php doc/devtools/release.php 12.6
  • Update working copy, 'y'
  • Update README, 'n'
  • Update language files, 'n' unless someone has made changes to the english text strings or translations.
  • Update changelog.txt, 'y' (If it was already updated the script will inform you if last commits were already inside)
  • Update copyright.txt, if there were no changes that appeared in the last step, you can type 'n', otherwise type 'y'.
  • Check syntax of PHP, 'n' unless there were changes to the code
  • Check syntax of Smarty Templapes, 'n' unless there were changes to the code
  • When prompted for Generate SecDB, if there has been a change to the SecDB file, type 'y', otherwise type 'n'.
  • Tag release, 'y'
  • Store Password on server, 'n'
  • Build packages files, 'y'


NB: To run the secdb update step php needs to be able to log into mysql, so you need to add the login info on the release.php command (until we work out a better way, 15.0alpha)

/usr/bin/php -d mysqli.default_host=localhost -d mysqli.default_user=root -d mysqli.default_pw=******* doc/devtools/release.php 15.0 alpha

Test

Download a copy of the new release for you and an other tester to try. Repeat the same testing process.

Clean Up

Once the packages are created, copy the tarball to the download area, and to avoid confusion when downloading, be sure to remove the pre-release tarball.

cd ~/tikipack/
cp -r 12.6 /var/local/release.tiki.org/www/download

Upload to Sourceforge

Login to source forge and create a folder in the appropriate directory, in this example I we navigate the TIki_12.x_Altrair folder and create a sub-folder called 12.6.

scp *bz2 *gz *zip *7z username,tikiwiki@frs.sourceforge.net:/home/pfs/project/t/ti/tikiwiki/Tiki_XX.x_Starname/XX.Y

Created by uxeric. Last Modification: Saturday 29 September, 2018 13:58:46 GMT-0000 by Marc Laporte.

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