Differences

This shows you the differences between two versions of the page.

--- mantisbt:git_submodules [2014/04/30 12:15] – fix commit reference dregad
+++ mantisbt:git_submodules [2014/04/30 13:00] (current) – Added update from within the submodule (phpmailer example) dregad
@@ Line 120: / Line 120: @@
 Submodule path 'library/adodb': checked out '<commit sha>'
 </code>
@@ Line 129: / Line 131: @@
 This section describes the process to update a submodule when a new version of a library has been released upstream.
-The examples given here are for the ADOdb library, but the same logic should apply (possibly with some variations) to other submodules as well.
+==== Updating via an external repository ====
+The example given here are for the ADOdb library, but the same logic should apply (possibly with some variations) to other submodules as well.
 We assume that you already have a local repository configured with the appropriate remotes (//upstream// for the library's official repository and //origin// for the MantisBT fork)
@@ Line 136: / Line 140: @@
 cd /path/to/local/adodb
 git fetch upstream
+</code>
+    * Optional: update the //master// branch <code>
+git rebase upstream/master master
 </code>
     * Update the branch <code>
@@ Line 143: / Line 150: @@
     * Resolve any conflicts
     * Push changes to the fork <code>
-git push origin
+git push origin --tags master mantis-1.3
-</code>
+</code> Note that it's not strictly necessary to push the tags or the master branch. Having the tags allows a better description of the submodule's current commit when running ''git submodule'' (see example at the end of this section)
   - Update the submodule
     * Go to your local mantisbt repository and update it<code>
@@ Line 157: / Line 164: @@
 cd ..
 </code>
-  - Update readme.libs to reflect the new version
+  - Update ''README.libs'' to reflect the new version
   - Commit the changes <code>
 git commit -a
@@ Line 171: / Line 178: @@
 beaddd279c695aacb63407e2c98b04b7eaff51 securimage (heads/mantis)
 </code>
+==== Updating from within the submodule ====
+It's worth mentioning that step 1 above can also be performed straight from the submodule itself (see example below for phpmailer), provided of course that the remotes (origin and upstream) have been properly configured.
+**WARNING**: if you update the submodule in-place, it is critical that you actually push the changes to //origin// otherwise the other developers will have an corrupted repository with missing commits when they pull the changes.
+  * Update the submodule from upstream <code>
+cd library/phpmailer
+git fetch upstream
+git rebase upstream/master master
+git checkout mantis
+git merge v5.2.7
+# Resolve conflicts
+</code>
+  * Push changes to the fork - **don't forget this step !**<code>
+git push origin --tags master mantis
+cd ..
+</code>
+  * Edit ''README.libs''
+  * Commit the changes <code>
+git commit -a
+</code>