.. SPDX-License-Identifier: CC-BY-4.0
.. (c) 2017 Mirantis Inc., Enea AB and others.
+==========================================
Fuel@OPNFV submodule fetching and patching
==========================================
developing/applying OPNFV patches (backports, custom fixes etc.).
The scripts should be friendly to the following 2 use-cases:
+
- development work: easily cloning, binding repos to specific commits,
remote tracking, patch development etc.;
- to provide parent build scripts an easy method of tracking upstream
references and applying OPNFV patches on top;
Also, we need to support at least the following modes of operations:
+
- submodule bind - each submodule patches will be based on the commit ID
saved in the .gitmodules config file;
- remote tracking - each submodule will sync with the upstream remote
and patches will be applied on top of <sub_remote>/<sub_branch>/HEAD;
Workflow (development)
-----------------------
+======================
+
The standard development workflow should look as follows:
-1. Decide whether remote tracking should be active or not:
- NOTE: Setting the following var to any non-empty str enables remote track.
- NOTE: Leaving unset will enable remote track for anything but stable branch.
+Decide whether remote tracking should be active or not
+------------------------------------------------------
+
+NOTE: Setting the following var to any non-empty str enables remote track.
+
+NOTE: Leaving unset will enable remote track for anything but stable branch.
+
+ .. code-block:: bash
+
+ $ export FUEL_TRACK_REMOTES=""
+
+Initialize git submodules
+-------------------------
+
+All Fuel sub-projects are registered as submodules.
+If remote tracking is active, upstream remote is queried and latest remote
+branch HEAD is fetched. Otherwise, checkout commit IDs from .gitmodules.
- $ export FUEL_TRACK_REMOTES=""
+ .. code-block:: bash
-2. All Fuel sub-projects are registered as submodules. To initialize them, call:
- If remote tracking is active, upstream remote is queried and latest remote
- branch HEAD is fetched. Otherwise, checkout commit IDs from .gitmodules.
+ $ make sub
- $ make sub
+Apply patches from `patches/<sub-project>/*` to respective submodules
+---------------------------------------------------------------------
-3. Apply patches from `patches/<sub-project>/*` to respective submodules via:
+This will result in creation of:
- $ make patches-import
+- a tag called `${FUEL_MAIN_TAG}-opnfv-root` at the same commit as Fuel@OPNFV
+ upstream reference (bound to git submodule OR tracking remote HEAD);
+- a new branch `opnfv-fuel` which will hold all the OPNFV patches,
+ each patch is applied on this new branch with `git-am`;
+- a tag called `${FUEL_MAIN_TAG}-opnfv` at `opnfv-fuel/HEAD`;
- This will result in creation of:
- - a tag called `${FUEL_MAIN_TAG}-opnfv-root` at the same commit as Fuel@OPNFV
- upstream reference (bound to git submodule OR tracking remote HEAD);
- - a new branch `opnfv-fuel` which will hold all the OPNFV patches,
- each patch is applied on this new branch with `git-am`;
- - a tag called `${FUEL_MAIN_TAG}-opnfv` at `opnfv-fuel/HEAD`;
+ .. code-block:: bash
-4. Modify sub-projects for whatever you need.
- Commit your changes when you want them taken into account in the build.
+ $ make patches-import
-5. Re-create patches via:
+Modify sub-projects for whatever you need
+-----------------------------------------
- $ make patches-export
+Commit your changes when you want them taken into account in the build.
- Each commit on `opnfv-fuel` branch of each subproject will be
- exported to `patches/subproject/` via `git format-patch`.
+Re-create patches
+-----------------
- NOTE: Only commit (-f) submodules when you need to bump upstream ref.
- NOTE: DO NOT commit patched submodules!
+Each commit on `opnfv-fuel` branch of each subproject will be
+exported to `patches/subproject/` via `git format-patch`.
-6. Clean workbench branches and tags with:
+NOTE: Only commit (-f) submodules when you need to bump upstream ref.
- $ make clean
+NOTE: DO NOT commit patched submodules!
-7. De-initialize submodules and force a clean clone with:
+ .. code-block:: bash
- $ make deepclean
+ $ make patches-export
+
+Clean workbench branches and tags
+---------------------------------
+
+ .. code-block:: bash
+
+ $ make clean
+
+De-initialize submodules and force a clean clone
+------------------------------------------------
+
+ .. code-block:: bash
+
+ $ make deepclean
Sub-project maintenance
------------------------
-1. Adding a new submodule
- If you need to add another subproject, you can do it with `git submodule`.
- Make sure that you specify branch (with `-b`), short name (with `--name`):
+=======================
+
+Adding a new submodule
+----------------------
+
+If you need to add another subproject, you can do it with `git submodule`.
+Make sure that you specify branch (with `-b`), short name (with `--name`):
+
+ .. code-block:: bash
+
+ $ git submodule -b master add --name reclass-system-salt-model
+ https://github.com/Mirantis/reclass-system-salt-model
+ relative/path/to/submodule
- $ git submodule -b master add --name reclass-system-salt-model \
- https://github.com/Mirantis/reclass-system-salt-model \
- relative/path/to/submodule
+Working with remote tracking for upgrading Fuel components
+----------------------------------------------------------
-2. Working with remote tracking for upgrading Fuel components
- Enable remote tracking as described above, which at `make sub` will update
- ALL submodules (e.g. reclass-system-salt-model) to remote branch (set in
- .gitmodules) HEAD.
+Enable remote tracking as described above, which at `make sub` will update
+ALL submodules (e.g. reclass-system-salt-model) to remote branch (set in
+.gitmodules) HEAD.
- * If upstream has NOT already tagged a new version, we can still work on
- our patches, make sure they apply etc., then check for new upstream
- changes (and that our patches still apply on top of them) by:
+* If upstream has NOT already tagged a new version, we can still work on
+ our patches, make sure they apply etc., then check for new upstream
+ changes (and that our patches still apply on top of them) by:
- $ make deepclean patches-import
+* If upstream has already tagged a new version we want to pick up, checkout
+ the new tag in each submodule:
- * If upstream has already tagged a new version we want to pick up, checkout
- the new tag in each submodule:
+* Once satisfied with the patch and submodule changes, commit them:
- $ git submodule foreach 'git checkout <newtag>'
+ - enforce FUEL_TRACK_REMOTES to "yes" if you want to constatly use the
+ latest remote branch HEAD (as soon as upstream pushes a change on that
+ branch, our next build will automatically include it - risk of our
+ patches colliding with new upstream changes);
+ - stage patch changes if any;
+ - if submodule tags have been updated (relevant when remote tracking is
+ disabled, i.e. we have a stable upstream baseline), add submodules;
- * Once satisfied with the patch and submodule changes, commit them:
- - enforce FUEL_TRACK_REMOTES to "yes" if you want to constatly use the
- latest remote branch HEAD (as soon as upstream pushes a change on that
- branch, our next build will automatically include it - risk of our
- patches colliding with new upstream changes);
- - stage patch changes if any;
- - if submodule tags have been updated (relevant when remote tracking is
- disabled, i.e. we have a stable upstream baseline), add submodules:
+ .. code-block:: bash
- $ make deepclean sub && git add -f relative/path/to/submodule
+ $ make deepclean patches-import
+ $ git submodule foreach 'git checkout <newtag>'
+ $ make deepclean sub && git add -f relative/path/to/submodule
Code Review / fuel.git / blobdiff