Loading...
 

Continuous Integration


Tiki releases every 6 months. However, the next release should ideally be "releasable at any time". So we:

GitLab CI


Most of the tests are now done via Gitlab CI , which is run on every commit.

See the pipeline status at https://gitlab.com/tikiwiki/tiki/pipelines

What do I need to know as a normal developer


The CI runs on every commit. This can take 10 minutes, so you want to run the main tests locally before you commit so you don't constantly break the build, and have to rework your merge request. See TikiDevNewbie

Running locally and improving the GitLab CI Pipeline as a developer


Why would you want to?

  1. To fix a pipeline failure when the code is correct
  2. To make the pipeline run faster/be less costly to run (external service quota, etc.)
  3. To make parts of the pipeline easier for other developers to work with, or to adapt the pipeline to changes in the underlying tiki tools and scripts.


The pipeline is run from the .gitlab-ci.yml commited in the repository. This is the syntax reference.

Traditionally, gitlab-ci.yml files are meant to be edited with the gitlab's pipeline editor. While a very nice tool to test and validate some aspects of the logic of that file, iterating on the pipeline and running the actual tests requires a commit. Even on a branch or clone, it is extremely time consuming.

So to work on it your should learn to:

Use the gitlab-ci-local tool


gitlab-ci-local, which allows you to run a specific job locally, mostly as it would on gitlab.

Copy to clipboard
gitlab-ci-local check-bom-encoding

Keep the actual tests executable locally


The gitlab-ci.yml file should only be concerned with setting up reproducible test environments, not setup tests that depend on one-another, etc. So the actual tests should be in separate scripts called from gitlab-ci.yml. Also, while a developer should not be expected to have every possible dependency installed, the tests should run in their local environment if they are working on this part of the code. For example, manticore tests should be runnable from however manticore is locally installed, not just from docker.

TODO: Clean up everything below. Most of it is still useful (2023-04-03, but hasn't been updated since we moved to gitlab-ci and docker)

Quality at Speed” is the new norm in software development


To get closer to these goals, the ideal would be community Continuous Integration server.

There are daily builds but if something breaks, there is no alert system to report the issue.

Wishlist for Tiki community

Pre-Dogfood Server

For humans to be able to see yesterday's data with tomorrow's code

Profiles demo server

  • Having a test server with main profiles applied regularly, for testing/demo.

Continuous build

For the daily pre-release zip file to be as close as possible to the final one

Continuous Testing Server

Machines testing code, according to a series of tests

  • Run all tests
    • Check PHP & Smarty Syntax, etc.
    • Check that all JavaScript can be safely minified with JSLint
    • Detect closing ?> tags from DevTips
  • Run the security tests regularly (monthly?) and report to Security Team about new potentially risky files
  • Ideas from How to improve the release process
  • php doc/devtools/translate.php englishupdate lag=10 audit --email=me@example.org to report if anyone breaks strings over the last 10 days
  • etc

Notes

Database Compare

In order to run the script doc/devtools/check_schema_upgrade.php which will compare your current database with what it should be you need to install DBDiff with this command:
. php temp/composer.phar require "dbdiff/dbdiff:@dev"

Related links

Alias

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
Diagram
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw -superseded by Diagram
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Gantt
Group
Groupmail
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Kanban
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
Terms and Conditions
Theme
TikiTests
Federated Timesheets
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