Git Workflow | Tiki Wiki CMS Groupware :: Development

Git Workflow | Tiki Wiki CMS Groupware :: Development
Loading...
Navigation and related functionality and content
Related content
Upcoming event:
21 May 26
Tiki Roundtable Meeting - May
Save to my calendar
View the event
Please wait
The PDF is being prepared....
13
Backlinks
Where to commit
Git
Manager
How to update composer lock
Easy for Newbie
DevTips
Rubix ML
Get Started
Get code
Commit Code
Git and SVN combined workflow
login from telegram
Slideshows based on structures
Structures
Developer Documentation
Git Workflow
Introduction
This article explains the workflow that should be followed to contribute to the Tiki GitLab repository at
. Following are the main steps:
Fork
the main Tiki GitLab repository to your GitLab account
Clone
the forked repository to your computer
Checkout
the correct target branch on your computer
Create a new branch
on your computer based on the target branch
Commit
changes to your local clone
Push
changes to your forked repository on GitLab
Create a new
Merge Request
from your forked repository on GitLab
Each of these steps is explained in more detail below.
1. Fork the main Tiki GitLab repository to your GitLab account
Create an account at
Go to Tiki project page,
Click on
fork
badge at top right corner
Select the target group you want to place your fork. It will take 15 minutes or more.
Mirroring your fork to the main Tiki repository
At this point, you will probably want to mirror your forked repository to the main Tiki repository so that your fork will be automatically updated for any commits to the main repository. To do this:
Go to the project page of your forked repository
In the menu on the left, click on Settings > Repository
Find the "Mirroring repositories" subheading and click the Expand button
Type
in the "Git repository URL" input field
Ensure the "Mirror direction" field is set to Pull. This
option
is only available on GitLab Premium.
If you keep your fork clean of changes by creating separate branches as described
below
, then check "Overwrite diverged branches". This
option
is also only available on GitLab Premium.
Click on the "Mirror repository" button
Your forked repository will be synced at least every hour. The main Tiki branches in your fork should not diverge from the main Tiki repository, otherwise the mirroring will fail or the branch on your fork will be overwritten (if you selected that option). This is another reason to keep the main branches clean and create a temporary local branch whenever making changes as discussed in number 4 below.
If mirroring stops working (which sometimes happens), you can manually sync each time before you start coding by following the steps below at
Manually Syncing Your Fork to the main Tiki Repository
2. Clone the forked repository to your computer
In this step, the repository you forked to your account on GitLab is cloned onto your local computer.
Examples of how to clone
The examples below use Git command line, but it can be performed in any Git client embedded in an IDE. Also
fabiomontefuscolo
is the GitLab user in this example and it should be replaced by GitLab user who forked the repository. Only one of the following examples (or another variation not shown here) should be applied.
Clone to a newly created directory named tiki
Copy to clipboard
$ git clone git@gitlab.com:fabiomontefuscolo/tiki.git tiki
Clone to current folder
Copy to clipboard
$ git clone git@gitlab.com:fabiomontefuscolo/tiki.git .
As Git will checkout all revisions since the beginning of Tiki (over 70 000 commits), will take quite a while, so you may want to limit this as in the following example:
Clone to current folder with 5 last revisions only
Copy to clipboard
$ git clone git@gitlab.com:fabiomontefuscolo/tiki.git . --depth=5
3. Checkout the correct target branch on your computer
For each major version of Tiki, there is a working branch. If the contribution is a fix for version 20.1 for example, the contributor must checkout the branch 20.x.
Note that unlike with SVN, checking out a branch with git does not mean downloading all of the tiki files for the branch into a separate folder. The folder where you cloned your fork will still be used, and the files in the folder will changed to reflect the branch that you've checked out.
Checkout branch 20.x on your computer
Copy to clipboard
$ git checkout 20.x
4. Create a new branch on your computer
This is a very important step. It is a good idea to create another branch for the contribution. According to earlier steps, the repository now is set to branch
20.x
and a new branch will start from this point. Suppose branch with the name
fixing-left-sidebar
, the following command will create this branch.
Create a local branch
Copy to clipboard
$ git checkout -b fixing-left-sidebar
If for some reason the contributor needs to stop his work and start a new one for the same branch
20.x
, he can simply commit or stash his changes, switch back to 20.x and create the new contribution he needs. For example, a new urgent task appeared to fix a security issue:
Create a second local branch
Copy to clipboard
$ git checkout 20.x
$ git checkout -b fixing-xss-issue-on-register-form
In this way, the contributor can have two ore more unrelated jobs (
fixing-left-sidebar
and
fixing-xss-issue-on-register-form
) for the same target branch (
20.x
). It will also help on
Merge Request
creation. Please see the
atomic commit convention
Similar to checking out a branch, a new local branch that you've created will still reside in the same folder that you cloned your forked repository into. As explained above, creating local branches is a simple and quick way to isolate different sets of changes so that you are always able to quickly switch back to a clean copy or between sets of changes.
5. Commit changes to your local clone
The community standards for commit messages should be respected please see:
Commit Message
Commit changes to your local clone
Copy to clipboard
$ git add tiki-file.php
$ git commit -m "[FIX] Removing bad characters from registration form to avoid XSS attacks"
6. Push changes to your forked repository on GitLab
In order to have changes available to create a new
Merge Request
, it is necessary to push the created branch to your forked repository on GitLab.
Push changes to your GitLab fork
Copy to clipboard
$ git push -u origin fixing-xss-issue-on-register-form
7. Create a new merge request from your forked repository on GitLab
The purpose of this step is to merge the changes pushed to your GitLab Tiki fork to a specific branch in the
main Tiki GitLab repository
Go to your forked repository page in GitLab
Then put mouse over
Repository
and click on
Branches
entry
Locate the branch desired (eg.: fixing-xss-issue-on-register-form) and then click on
Merge Request
button
On top right corner, click on
Change branches
and select the correct target branch (eg.: 20.x)
Write a detailed description. Include steps to reproduce a bug if needed or how to test a new feature
Check your merge request via the web interface
Here is an example:
Find yours here:
Make sure you are respecting the
atomic commit convention
If there is an issue, fix quickly or indicate in the comments that you will do later, or that you need help.
Wait and interact
Maintainers may ask you changes on that pull request. In this case, just checkout the branch related to the merge request, add new commits and push it again.
To backport a commit
first check that we have the branch on which we want to backport the commit if not track it
to check
git branch -a
to track and clone the branch's commits
git remote add --track 25.x 25.x-track
git fetch 25.x-track --depth=500
move to a new branch with the elements we just downloaded
git checkout -b fixCorruption 25.x-track/25.x
do the cherry pick
git cherry-pick a12f4017cf6b13eefab06f8110ff5aa2516439d3
a12f4017cf6b13eefab06f8110ff5aa2516439d3 This is the hash of the commit after being merged
then make a push and create a new merge request to the desired branch
git push -u origin fixCorruption
Important
When commands like
git reset --hard
or
git push --force
is needed, it may be that there is a problem with the workflow and it should be planned again.
After backporting, please make sure to reference the original MR in the description or comment. The point it to create activity on the original MR so we know it was backported, if we need to remove the tag, etc.
Manually Syncing Your Fork to the main Tiki Repository
An alternative to mirroring your fork as described in
Mirroring your fork to the main Tiki repository
, is to manually sync it as follows:
Add the main Tiki repository as a remote with the command
Copy to clipboard
git remote add upstream https://gitlab.com/tikiwiki/tiki.git
Note, you only need to do this step once
Apply commits from the main Tiki repository to your local repository with the command
git pull upstream master --rebase
Apply those commits from your local repository to your forked repository with the command
git push origin master
If you get an error message after attempting this push to your forked repository and there is no other activity on that repository (
e.g.
, it is only used by you for merge requests), try
git push origin master --force
You should sync often, especially before making changes locally, and after committing but before pushing to your fork.
Fix Out-of-Sync Fork
Sometimes your forked repository can get out of sync with the main Tiki repository and your local copy. Symptoms are when you frequently have to force push to the fork, or unwanted other commits from other authors are combined into a merge request made from your fork to the main repository. Follow these steps to fix:
Copy to clipboard
git fetch upstream
git checkout master
git reset --hard upstream/master
git push origin master --force
See also
Backport changes using Git
Tiki Unit Testing
alias
Git workflow For Collaborators
History
Source
Comments
Related content
Future version
More content and functionality (right side)
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
(WAI & 508)
Accounting
Administration
Ajax
Articles
& Submissions
Backlinks
Banner
Batch
BigBlueButton
audio/video/chat/screensharing
Blog
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts
Address book
Content template
Contribution
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
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
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)
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
Last Changed Items
User Information popover is missing the user avatar (regression)
Possible to see admin "Advanced" options when the parent "Experimental" feature is not visible
Module order changes can't be saved
CAS Authentication
Error in upgrade script (function upgrade_20120429_fix_collation_tiki)
Last Changed Pages
Tiki30
Make a wish - reproduce your bug
makeawish-reproduce_tpl
Endangered features
Strings Format Convention
...more
Useful Tools
PhpStorm
by
JetBrains
Show PHP error messages
NOTICE (E_USER_NOTICE):
Undefined array key "module_last_modif_tracker_comments"
At line 537 in lib/modules/modlib.php
ERROR (E_WARNING):
Trying to access array offset on null
At line 27 in vendor_bundled/vendor/smarty/smarty/src/Template/Compiled.php(162) : eval()'d code